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