include/cppu/Map.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23
  24 #ifndef INCLUDED_CPPU_MAP_HXX
  25 #define INCLUDED_CPPU_MAP_HXX
  26
  27 #include "uno/mapping.hxx"
  28
  29
  30 namespace cppu
  31 {
  32     /** Helpers for mapping objects relative to the current environment.
  33         (http://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Map_Helpers)
  34     */
  35
  36     /** Maps an object from the current to an outer Environment, returns mapped object.
  37
  38         @param  pT        the object to be mapped
  39         @param  outerEnv  the target environment
  40         @return           the mapped object
  41         @since UDK 3.2.7
  42      */
  43     template<class T> inline T * mapOut(T * pT, css::uno::Environment const & outerEnv)
  44     {
  45         css::uno::Mapping curr2outer(css::uno::Environment::getCurrent(), outerEnv);
  46
  47         return reinterpret_cast<T *>(curr2outer.mapInterface(pT, cppu::UnoType<T>::get()));
  48     }
  49
  50
  51     /** Maps an object from an outer Environment to the current, returns mapped object.
  52
  53         @param  pT        the object to be mapped
  54         @param  outerEnv  the source environment
  55         @return           the mapped object
  56         @since UDK 3.2.7
  57      */
  58     template<class T> inline T * mapIn(T * pT, css::uno::Environment const & outerEnv)
  59     {
  60         css::uno::Mapping outer2curr(outerEnv, css::uno::Environment::getCurrent());
  61
  62         return reinterpret_cast<T *>(outer2curr.mapInterface(pT, cppu::UnoType<T>::get()));
  63     }
  64
  65
  66     /** Maps an any from the current to an outer Environment, fills passed any.
  67
  68         @param  any       the any to be mapped
  69         @param  res       the target any
  70         @param  outerEnv  the target environment
  71         @since UDK 3.2.7
  72      */
  73     // Problem: any gets assigned to something, acquire/releases may be called in wrong env.
  74     inline void mapOutAny(css::uno::Any const & any, css::uno::Any * res, css::uno::Environment const & outerEnv)
  75     {
  76         css::uno::Mapping curr2outer(css::uno::Environment::getCurrent(), outerEnv);
  77
  78         uno_any_destruct(res, css::uno::cpp_release);
  79         uno_type_any_constructAndConvert(
  80             res,
  81             const_cast<void *>(any.getValue()),
  82             any.getValueTypeRef(),
  83             curr2outer.get());
  84     }
  85
  86
  87     /** Maps an any from an outer Environment to the current, fills passed any.
  88
  89         @param  any       the any to be mapped
  90         @param  res       the target any
  91         @param  outerEnv  the source environment
  92         @since UDK 3.2.7
  93      */
  94     inline void mapInAny(css::uno::Any const & any, css::uno::Any * res, css::uno::Environment const & outerEnv)
  95     {
  96         css::uno::Mapping outer2curr(outerEnv, css::uno::Environment::getCurrent());
  97
  98         uno_any_destruct(res, css::uno::cpp_release);
  99         uno_type_any_constructAndConvert(
 100             res,
 101             const_cast<void *>(any.getValue()),
 102             any.getValueTypeRef(),
 103             outer2curr.get());
 104     }
 105 }
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */