office-gobmx/include/uno/current_context.hxx
msrijita18 b1fb6338cf tdf#130978 Added comment to all published API
Change-Id: I744788bde9778f85ccd9d7667e19d16842900a29
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/110248
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2021-02-02 20:56:27 +01:00

122 lines
3.6 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
/*
* This file is part of LibreOffice published API.
*/
#ifndef INCLUDED_UNO_CURRENT_CONTEXT_HXX
#define INCLUDED_UNO_CURRENT_CONTEXT_HXX
#include "sal/config.h"
#include <cstddef>
#include "uno/current_context.h"
#include "uno/lbnames.h"
#include "com/sun/star/uno/XCurrentContext.hpp"
namespace com
{
namespace sun
{
namespace star
{
namespace uno
{
/** Getting the current context.
@attention
Don't spread the returned interface around to other threads. Every thread has its own
current context.
@return current context or null ref, if none is set
*/
inline Reference< XCurrentContext > SAL_CALL getCurrentContext()
{
Reference< XCurrentContext > xRet;
::rtl::OUString aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME );
::uno_getCurrentContext( reinterpret_cast<void **>(&xRet), aEnvTypeName.pData, NULL );
return xRet;
}
/** Setting the current context.
@param xContext current context to be set
@return true, if context has been successfully set
*/
inline bool SAL_CALL setCurrentContext(
Reference< XCurrentContext > const & xContext )
{
::rtl::OUString aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME );
return ::uno_setCurrentContext( xContext.get(), aEnvTypeName.pData, NULL );
}
/** Objects of this class are used for applying a current context until they are destructed, i.e.
the ctor of this class saves the previous and sets the given context while the dtor restores
the previous one upon destruction.
*/
class ContextLayer
{
/** this C++ environment type name.
*/
::rtl::OUString m_aEnvTypeName;
/** previous context
*/
Reference< XCurrentContext > m_xPreviousContext;
public:
/** Constructor: Saves the previous context and sets the new (given) one.
@param xNewContext new context to be set
*/
inline ContextLayer(
Reference< XCurrentContext > const & xNewContext = Reference< XCurrentContext >() );
/** Destructor: restores the previous context.
*/
inline ~ContextLayer();
/** Gets the previously set context.
@return the previously set context
*/
Reference< XCurrentContext > SAL_CALL getPreviousContext() const
{ return m_xPreviousContext; }
};
inline ContextLayer::ContextLayer( Reference< XCurrentContext > const & xNewContext )
: m_aEnvTypeName( CPPU_CURRENT_LANGUAGE_BINDING_NAME )
{
::uno_getCurrentContext( reinterpret_cast<void **>(&m_xPreviousContext), m_aEnvTypeName.pData, NULL );
::uno_setCurrentContext( xNewContext.get(), m_aEnvTypeName.pData, NULL );
}
inline ContextLayer::~ContextLayer()
{
::uno_setCurrentContext( m_xPreviousContext.get(), m_aEnvTypeName.pData, NULL );
}
}
}
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */