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 #ifndef INCLUDED_CPPU_MAP_HXX
  21 #define INCLUDED_CPPU_MAP_HXX
  22
  23 #include "uno/mapping.hxx"
  24
  25
  26 namespace cppu
  27 {
  28     /** Helpers for mapping objects relative to the current environment.
  29         (http://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Map_Helpers)
  30     */
  31
  32     /** Maps an object from the current to an outer Environment, returns mapped object.
  33
  34         @param  pT        the object to be mapped
  35         @param  outerEnv  the target environment
  36         @return           the mapped object
  37         @since UDK 3.2.7
  38      */
  39     template<class T> inline T * mapOut(T * pT, css::uno::Environment const & outerEnv)
  40     {
  41         css::uno::Mapping curr2outer(css::uno::Environment::getCurrent(), outerEnv);
  42
  43         return reinterpret_cast<T *>(curr2outer.mapInterface(pT, cppu::UnoType<T>::get()));
  44     }
  45
  46
  47     /** Maps an object from an outer Environment to the current, returns mapped object.
  48
  49         @param  pT        the object to be mapped
  50         @param  outerEnv  the source environment
  51         @return           the mapped object
  52         @since UDK 3.2.7
  53      */
  54     template<class T> inline T * mapIn(T * pT, css::uno::Environment const & outerEnv)
  55     {
  56         css::uno::Mapping outer2curr(outerEnv, css::uno::Environment::getCurrent());
  57
  58         return reinterpret_cast<T *>(outer2curr.mapInterface(pT, cppu::UnoType<T>::get()));
  59     }
  60
  61
  62     /** Maps an any from the current to an outer Environment, fills passed any.
  63
  64         @param  any       the any to be mapped
  65         @param  res       the target any
  66         @param  outerEnv  the target environment
  67         @since UDK 3.2.7
  68      */
  69     // Problem: any gets assigned to something, acquire/releases may be called in wrong env.
  70     inline void mapOutAny(css::uno::Any const & any, css::uno::Any * res, css::uno::Environment const & outerEnv)
  71     {
  72         css::uno::Mapping curr2outer(css::uno::Environment::getCurrent(), outerEnv);
  73
  74         uno_any_destruct(res, css::uno::cpp_release);
  75         uno_type_any_constructAndConvert(
  76             res,
  77             const_cast<void *>(any.getValue()),
  78             any.getValueTypeRef(),
  79             curr2outer.get());
  80     }
  81
  82
  83     /** Maps an any from an outer Environment to the current, fills passed any.
  84
  85         @param  any       the any to be mapped
  86         @param  res       the target any
  87         @param  outerEnv  the source environment
  88         @since UDK 3.2.7
  89      */
  90     inline void mapInAny(css::uno::Any const & any, css::uno::Any * res, css::uno::Environment const & outerEnv)
  91     {
  92         css::uno::Mapping outer2curr(outerEnv, css::uno::Environment::getCurrent());
  93
  94         uno_any_destruct(res, css::uno::cpp_release);
  95         uno_type_any_constructAndConvert(
  96             res,
  97             const_cast<void *>(any.getValue()),
  98             any.getValueTypeRef(),
  99             outer2curr.get());
 100     }
 101 }
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */