xref: /trunk/main/cppu/inc/cppu/Map.hxx (revision c059a6bf)

/**************************************************************
 *
 * 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 INCLUDED_cppu_Map_hxx
#define INCLUDED_cppu_Map_hxx

#include <uno/mapping.hxx>


namespace cssu = com::sun::star::uno;

namespace cppu
{
    /** Helpers for mapping objects relative to the current environment.
        (https://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Map_Helpers)
    */

    /** Maps an object from the current to an outer Environment, returns mapped object.

        @param  pT        the object to be mapped
        @param  outerEnv  the target environment
        @return           the mapped object
        @since UDK 3.2.7
     */
	template<class T> inline T * mapOut(T * pT, cssu::Environment const & outerEnv)
	{
		cssu::Mapping curr2outer(cssu::Environment::getCurrent(), outerEnv);

		return reinterpret_cast<T *>(curr2outer.mapInterface(pT, getCppuType((cssu::Reference<T> *)NULL)));
	}


    /** Maps an object from an outer Environment to the current, returns mapped object.

        @param  pT        the object to be mapped
        @param  outerEnv  the source environment
        @return           the mapped object
        @since UDK 3.2.7
     */
	template<class T> inline T * mapIn(T * pT, cssu::Environment const & outerEnv)
	{
		cssu::Mapping outer2curr(outerEnv, cssu::Environment::getCurrent());

		return reinterpret_cast<T *>(outer2curr.mapInterface(pT, getCppuType((cssu::Reference<T> *)NULL)));
	}


    /** Maps an any from the current to an outer Environment, fills passed any.

        @param  any       the any to be mapped
        @param  res       the target any
        @param  outerEnv  the target environment
        @since UDK 3.2.7
     */
    // Problem: any gets assigned to something, acquire/releases may be called in wrong env.
	inline void mapOutAny(cssu::Any const & any, cssu::Any * res, cssu::Environment const & outerEnv)
	{
		cssu::Mapping curr2outer(cssu::Environment::getCurrent(), outerEnv);

		uno_any_destruct(res, (uno_ReleaseFunc)cssu::cpp_release);
		uno_type_any_constructAndConvert(
			res,
			const_cast<void *>(any.getValue()),
			any.getValueTypeRef(),
			curr2outer.get());
	}


    /** Maps an any from an outer Environment to the current, fills passed any.

        @param  any       the any to be mapped
        @param  res       the target any
        @param  outerEnv  the source environment
        @since UDK 3.2.7
     */
	inline void mapInAny(cssu::Any const & any, cssu::Any * res, cssu::Environment const & outerEnv)
	{
		cssu::Mapping outer2curr(outerEnv, cssu::Environment::getCurrent());

		uno_any_destruct(res, (uno_ReleaseFunc)cssu::cpp_release);
		uno_type_any_constructAndConvert(
			res,
			const_cast<void *>(any.getValue()),
			any.getValueTypeRef(),
			outer2curr.get());
	}
}

#endif