xref: /aoo41x/main/cppu/inc/uno/mapping.hxx (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef _UNO_MAPPING_HXX_
#define _UNO_MAPPING_HXX_

#include <cppu/macros.hxx>
#include <rtl/alloc.h>
#include <rtl/ustring.hxx>
#include <uno/mapping.h>
#include <com/sun/star/uno/Type.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include "cppu/unotype.hxx"
#include "uno/environment.hxx"

typedef struct _typelib_TypeDescription typelib_TypeDescription;
typedef struct _typelib_InterfaceTypeDescription typelib_InterfaceTypeDescription;
typedef struct _uno_Interface uno_Interface;

namespace com
{
namespace sun
{
namespace star
{
namespace uno
{

/** C++ wrapper for C uno_Mapping.

    @see uno_Mapping
*/
class Mapping
{
	uno_Mapping * _pMapping;

public:
	// these are here to force memory de/allocation to sal lib.
    /** @internal */
	inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () )
		{ return ::rtl_allocateMemory( nSize ); }
    /** @internal */
	inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () )
		{ ::rtl_freeMemory( pMem ); }
    /** @internal */
	inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () )
		{ return pMem; }
    /** @internal */
	inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () )
		{}

	/** Holds a mapping from the specified source to the specified destination by environment
        type names.

		@param rFrom		type name of source environment
		@param rTo			type name of destination environment
		@param rAddPurpose	additional purpose
	*/
	inline Mapping(
        const ::rtl::OUString & rFrom, const ::rtl::OUString & rTo,
        const ::rtl::OUString & rAddPurpose = ::rtl::OUString() )
        SAL_THROW( () );

	/** Holds a mapping from the specified source to the specified destination.

		@param pFrom		source environment
		@param pTo			destination environment
		@param rAddPurpose	additional purpose
	*/
	inline Mapping(
        uno_Environment * pFrom, uno_Environment * pTo,
        const ::rtl::OUString & rAddPurpose = ::rtl::OUString() )
        SAL_THROW( () );

	/** Holds a mapping from the specified source to the specified destination
		environment.

		@param from         source environment
		@param to           destination environment
		@param rAddPurpose  additional purpose
	*/
	inline Mapping(const Environment & rFrom, const Environment & rTo,
				   const ::rtl::OUString & rAddPurpose = ::rtl::OUString() )
		SAL_THROW( () );

	/** Constructor.

		@param pMapping another mapping
	*/
	inline Mapping( uno_Mapping * pMapping = 0 ) SAL_THROW( () );

	/** Copy constructor.

		@param rMapping another mapping
	*/
	inline Mapping( const Mapping & rMapping ) SAL_THROW( () );

	/** Destructor.
	*/
	inline ~Mapping() SAL_THROW( () );

	/** Sets a given mapping.

		@param pMapping another mapping
		@return this mapping
	*/
	inline Mapping & SAL_CALL operator = ( uno_Mapping * pMapping ) SAL_THROW( () );
	/** Sets a given mapping.

		@param rMapping another mapping
		@return this mapping
	*/
	inline Mapping & SAL_CALL operator = ( const Mapping & rMapping ) SAL_THROW( () )
		{ return operator = ( rMapping._pMapping ); }

	/** Provides a pointer to the C mapping. The returned mapping is NOT acquired!

		@return UNacquired C mapping
	*/
	inline uno_Mapping * SAL_CALL get() const SAL_THROW( () )
		{ return _pMapping; }

	/** Tests if a mapping is set.

		@return true if a mapping is set
	*/
	inline sal_Bool SAL_CALL is() const SAL_THROW( () )
		{ return (_pMapping != 0); }

	/** Releases a set mapping.
	*/
	inline void SAL_CALL clear() SAL_THROW( () );

	/** Maps an interface from one environment to another.

		@param pInterface		source interface
		@param pTypeDescr		type description of interface
		@return					mapped interface
	*/
	inline void * SAL_CALL mapInterface( void * pInterface, typelib_InterfaceTypeDescription * pTypeDescr ) const SAL_THROW( () );
	/** Maps an interface from one environment to another.

		@param pInterface		source interface
		@param pTypeDescr		type description of interface
		@return					mapped interface
	*/
	inline void * SAL_CALL mapInterface( void * pInterface, typelib_TypeDescription * pTypeDescr ) const SAL_THROW( () )
		{ return mapInterface( pInterface, (typelib_InterfaceTypeDescription *)pTypeDescr ); }

	/** Maps an interface from one environment to another.

		@param pInterface		source interface
		@param rType			type of interface
		@return					mapped interface
	*/
	inline void * SAL_CALL mapInterface(
		void * pInterface, const ::com::sun::star::uno::Type & rType ) const SAL_THROW( () );

	/** Maps an interface from one environment to another.

		@param ppOut			inout mapped interface
		@param pInterface		source interface
		@param pTypeDescr		type description of interface
	*/
	inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, typelib_InterfaceTypeDescription * pTypeDescr ) const SAL_THROW( () )
		{ (*_pMapping->mapInterface)( _pMapping, ppOut, pInterface, pTypeDescr ); }
	/** Maps an interface from one environment to another.

		@param ppOut			inout mapped interface
		@param pInterface		source interface
		@param pTypeDescr		type description of interface
	*/
	inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, typelib_TypeDescription * pTypeDescr ) const SAL_THROW( () )
		{ (*_pMapping->mapInterface)( _pMapping, ppOut, pInterface, (typelib_InterfaceTypeDescription *)pTypeDescr ); }

	/** Maps an interface from one environment to another.

		@param ppOut			inout mapped interface
		@param pInterface		source interface
		@param rType			type of interface to be mapped
	 */
	inline void SAL_CALL mapInterface( void ** ppOut, void * pInterface, const ::com::sun::star::uno::Type & rType ) const SAL_THROW( () );
};
//__________________________________________________________________________________________________
inline Mapping::Mapping(
	const ::rtl::OUString & rFrom, const ::rtl::OUString & rTo, const ::rtl::OUString & rAddPurpose )
	SAL_THROW( () )
	: _pMapping( 0 )
{
	uno_getMappingByName( &_pMapping, rFrom.pData, rTo.pData, rAddPurpose.pData );
}
//__________________________________________________________________________________________________
inline Mapping::Mapping(
	uno_Environment * pFrom, uno_Environment * pTo, const ::rtl::OUString & rAddPurpose )
	SAL_THROW( () )
	: _pMapping( 0 )
{
	uno_getMapping( &_pMapping, pFrom, pTo, rAddPurpose.pData );
}
//__________________________________________________________________________________________________
inline Mapping::Mapping(
	const Environment & rFrom, const Environment & rTo, const ::rtl::OUString & rAddPurpose )
	SAL_THROW( () )
		: _pMapping(0)
{
	uno_getMapping( &_pMapping, rFrom.get(), rTo.get(), rAddPurpose.pData );
}
//__________________________________________________________________________________________________
inline Mapping::Mapping( uno_Mapping * pMapping ) SAL_THROW( () )
	: _pMapping( pMapping )
{
	if (_pMapping)
		(*_pMapping->acquire)( _pMapping );
}
//__________________________________________________________________________________________________
inline Mapping::Mapping( const Mapping & rMapping ) SAL_THROW( () )
	: _pMapping( rMapping._pMapping )
{
	if (_pMapping)
		(*_pMapping->acquire)( _pMapping );
}
//__________________________________________________________________________________________________
inline Mapping::~Mapping() SAL_THROW( () )
{
	if (_pMapping)
		(*_pMapping->release)( _pMapping );
}
//__________________________________________________________________________________________________
inline void Mapping::clear() SAL_THROW( () )
{
	if (_pMapping)
	{
		(*_pMapping->release)( _pMapping );
		_pMapping = 0;
	}
}
//__________________________________________________________________________________________________
inline Mapping & Mapping::operator = ( uno_Mapping * pMapping ) SAL_THROW( () )
{
	if (pMapping)
		(*pMapping->acquire)( pMapping );
	if (_pMapping)
		(*_pMapping->release)( _pMapping );
	_pMapping = pMapping;
	return *this;
}
//__________________________________________________________________________________________________
inline void Mapping::mapInterface(
	void ** ppOut, void * pInterface, const ::com::sun::star::uno::Type & rType ) const
	SAL_THROW( () )
{
	typelib_TypeDescription * pTD = 0;
	TYPELIB_DANGER_GET( &pTD, rType.getTypeLibType() );
	if (pTD)
	{
		(*_pMapping->mapInterface)( _pMapping, ppOut, pInterface, (typelib_InterfaceTypeDescription *)pTD );
		TYPELIB_DANGER_RELEASE( pTD );
	}
}
//__________________________________________________________________________________________________
inline void * Mapping::mapInterface(
	void * pInterface, typelib_InterfaceTypeDescription * pTypeDescr ) const
	SAL_THROW( () )
{
	void * pOut = 0;
	(*_pMapping->mapInterface)( _pMapping, &pOut, pInterface, pTypeDescr );
	return pOut;
}
//__________________________________________________________________________________________________
inline void * Mapping::mapInterface(
	void * pInterface, const ::com::sun::star::uno::Type & rType ) const
	SAL_THROW( () )
{
	void * pOut = 0;
	mapInterface( &pOut, pInterface, rType );
	return pOut;
}

/** Deprecated. This function DOES NOT WORK with Purpose Environments
    (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)

    Maps an binary C UNO interface to be used in the currently used compiler environment.

    @tplparam C interface type
    @param ppRet inout returned interface pointer
    @param pUnoI binary C UNO interface
    @return true if successful, false otherwise

    @deprecated
*/
template< class C >
inline sal_Bool mapToCpp( Reference< C > * ppRet, uno_Interface * pUnoI ) SAL_THROW( () )
{
	Mapping aMapping(
		::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(UNO_LB_UNO) ),
		::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) ) );
	OSL_ASSERT( aMapping.is() );
	aMapping.mapInterface(
            (void **)ppRet, pUnoI, ::cppu::getTypeFavourUnsigned( ppRet ) );
	return (0 != *ppRet);
}
/** Deprecated. This function DOES NOT WORK with Purpose Environments
    (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)

    Maps an UNO interface of the currently used compiler environment to binary C UNO.

    @tplparam C interface type
    @param ppRet inout returned interface pointer
    @param x interface reference
    @return true if successful, false otherwise

    @deprecated
*/
template< class C >
inline sal_Bool mapToUno( uno_Interface ** ppRet, const Reference< C > & x ) SAL_THROW( () )
{
	Mapping aMapping(
		::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) ),
		::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(UNO_LB_UNO) ) );
	OSL_ASSERT( aMapping.is() );
	aMapping.mapInterface(
            (void **)ppRet, x.get(), ::cppu::getTypeFavourUnsigned( &x ) );
	return (0 != *ppRet);
}

}
}
}
}

#endif