include/uno/current_context.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 #ifndef INCLUDED_UNO_CURRENT_CONTEXT_HXX
  20 #define INCLUDED_UNO_CURRENT_CONTEXT_HXX
  21
  22 #include <sal/config.h>
  23
  24 #include <cstddef>
  25
  26 #include <uno/current_context.h>
  27 #include <uno/lbnames.h>
  28
  29 #include <com/sun/star/uno/XCurrentContext.hpp>
  30
  31
  32 namespace com
  33 {
  34 namespace sun
  35 {
  36 namespace star
  37 {
  38 namespace uno
  39 {
  40
  41 /** Getting the current context.
  42     @attention
  43     Don't spread the returned interface around to other threads.  Every thread has its own
  44     current context.
  45
  46     @return current context or null ref, if none is set
  47 */
  48 inline Reference< XCurrentContext > SAL_CALL getCurrentContext()
  49 {
  50     Reference< XCurrentContext > xRet;
  51     ::rtl::OUString aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME );
  52     ::uno_getCurrentContext( reinterpret_cast<void **>(&xRet), aEnvTypeName.pData, NULL );
  53     return xRet;
  54 }
  55 /** Setting the current context.
  56
  57     @param xContext current context to be set
  58     @return true, if context has been successfully set
  59 */
  60 inline bool SAL_CALL setCurrentContext(
  61     Reference< XCurrentContext > const & xContext )
  62 {
  63     ::rtl::OUString aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME );
  64     return ::uno_setCurrentContext( xContext.get(), aEnvTypeName.pData, NULL );
  65 }
  66
  67 /** Objects of this class are used for applying a current context until they are destructed, i.e.
  68     the ctor of this class saves the previous and sets the given context while the dtor restores
  69     the previous one upon destruction.
  70 */
  71 class ContextLayer
  72 {
  73     /** this C++ environment type name.
  74     */
  75     ::rtl::OUString m_aEnvTypeName;
  76     /** previous context
  77     */
  78     Reference< XCurrentContext > m_xPreviousContext;
  79
  80 public:
  81     /** Constructor: Saves the previous context and sets the new (given) one.
  82
  83         @param xNewContext new context to be set
  84     */
  85     inline ContextLayer(
  86         Reference< XCurrentContext > const & xNewContext = Reference< XCurrentContext >() );
  87     /** Destructor: restores the previous context.
  88     */
  89     inline ~ContextLayer();
  90
  91     /** Gets the previously set context.
  92
  93         @return the previously set context
  94     */
  95     inline Reference< XCurrentContext > SAL_CALL getPreviousContext() const
  96         { return m_xPreviousContext; }
  97 };
  98
  99 inline ContextLayer::ContextLayer( Reference< XCurrentContext > const & xNewContext )
 100     : m_aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME )
 101 {
 102     ::uno_getCurrentContext( reinterpret_cast<void **>(&m_xPreviousContext), m_aEnvTypeName.pData, NULL );
 103     ::uno_setCurrentContext( xNewContext.get(), m_aEnvTypeName.pData, NULL );
 104 }
 105
 106 inline ContextLayer::~ContextLayer()
 107 {
 108     ::uno_setCurrentContext( m_xPreviousContext.get(), m_aEnvTypeName.pData, NULL );
 109 }
 110
 111 }
 112 }
 113 }
 114 }
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */