cppu/inc/uno/current_context.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: current_context.hxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _UNO_CURRENT_CONTEXT_HXX_
  31 #define _UNO_CURRENT_CONTEXT_HXX_
  32
  33 #include <uno/current_context.h>
  34
  35 #include <com/sun/star/uno/XCurrentContext.hpp>
  36
  37
  38 namespace com
  39 {
  40 namespace sun
  41 {
  42 namespace star
  43 {
  44 namespace uno
  45 {
  46
  47 /** Getting the current context.
  48     @attention
  49     Don't spread the returned interface around to other threads.  Every thread has its own
  50     current context.
  51
  52     @return current context or null ref, if none is set
  53 */
  54 inline Reference< XCurrentContext > SAL_CALL getCurrentContext()
  55     SAL_THROW( () )
  56 {
  57     Reference< XCurrentContext > xRet;
  58     ::rtl::OUString aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) );
  59     ::uno_getCurrentContext( (void **)&xRet, aEnvTypeName.pData, 0 );
  60     return xRet;
  61 }
  62 /** Setting the current context.
  63
  64     @param xContext current context to be set
  65     @return true, if context has been successfully set
  66 */
  67 inline bool SAL_CALL setCurrentContext(
  68     Reference< XCurrentContext > const & xContext )
  69     SAL_THROW( () )
  70 {
  71     ::rtl::OUString aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) );
  72     return (::uno_setCurrentContext( xContext.get(), aEnvTypeName.pData, 0 ) != sal_False);
  73 }
  74
  75 /** Objects of this class are used for applying a current context until they are destructed, i.e.
  76     the ctor of this class saves the previous and sets the given context while the dtor restores
  77     the previous one upon destruction.
  78 */
  79 class ContextLayer
  80 {
  81     /** this C++ environment type name.
  82         @internal
  83     */
  84     ::rtl::OUString m_aEnvTypeName;
  85     /** previous context
  86         @internal
  87     */
  88     Reference< XCurrentContext > m_xPreviousContext;
  89
  90 public:
  91     /** Constructor: Saves the previous context and sets the new (given) one.
  92
  93         @param xNewContext new context to be set
  94     */
  95     inline ContextLayer(
  96         Reference< XCurrentContext > const & xNewContext = Reference< XCurrentContext >() )
  97         SAL_THROW( () );
  98     /** Destructor: restores the previous context.
  99     */
 100     inline ~ContextLayer() SAL_THROW( () );
 101
 102     /** Gets the previously set context.
 103
 104         @return the previously set context
 105     */
 106     inline Reference< XCurrentContext > SAL_CALL getPreviousContext() const
 107         SAL_THROW( () )
 108         { return m_xPreviousContext; }
 109 };
 110 //__________________________________________________________________________________________________
 111 inline ContextLayer::ContextLayer( Reference< XCurrentContext > const & xNewContext )
 112     SAL_THROW( () )
 113     : m_aEnvTypeName( RTL_CONSTASCII_USTRINGPARAM(CPPU_CURRENT_LANGUAGE_BINDING_NAME) )
 114 {
 115     ::uno_getCurrentContext( (void **)&m_xPreviousContext, m_aEnvTypeName.pData, 0 );
 116     ::uno_setCurrentContext( xNewContext.get(), m_aEnvTypeName.pData, 0 );
 117 }
 118 //__________________________________________________________________________________________________
 119 inline ContextLayer::~ContextLayer()
 120     SAL_THROW( () )
 121 {
 122     ::uno_setCurrentContext( m_xPreviousContext.get(), m_aEnvTypeName.pData, 0 );
 123 }
 124
 125 }
 126 }
 127 }
 128 }
 129
 130 #endif