1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski #ifndef _UNO_ENVIRONMENT_HXX_
24*b1cdbd2cSJim Jagielski #define _UNO_ENVIRONMENT_HXX_
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski #include <rtl/alloc.h>
27*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
28*b1cdbd2cSJim Jagielski #include <uno/environment.h>
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski #include "uno/lbnames.h"
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski /** */ //for docpp
33*b1cdbd2cSJim Jagielski namespace com
34*b1cdbd2cSJim Jagielski {
35*b1cdbd2cSJim Jagielski /** */ //for docpp
36*b1cdbd2cSJim Jagielski namespace sun
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski /** */ //for docpp
39*b1cdbd2cSJim Jagielski namespace star
40*b1cdbd2cSJim Jagielski {
41*b1cdbd2cSJim Jagielski /** */ //for docpp
42*b1cdbd2cSJim Jagielski namespace uno
43*b1cdbd2cSJim Jagielski {
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski /** C++ wrapper for binary C uno_Environment.
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski @see uno_Environment
48*b1cdbd2cSJim Jagielski */
49*b1cdbd2cSJim Jagielski class Environment
50*b1cdbd2cSJim Jagielski {
51*b1cdbd2cSJim Jagielski /** binary C uno_Environment
52*b1cdbd2cSJim Jagielski */
53*b1cdbd2cSJim Jagielski uno_Environment * _pEnv;
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski public:
56*b1cdbd2cSJim Jagielski /** Returns the current Environment.
57*b1cdbd2cSJim Jagielski
58*b1cdbd2cSJim Jagielski @param env_type the optional type of the Environment, falls back to "uno" in case being empty,
59*b1cdbd2cSJim Jagielski respectively to current C++ Environment.
60*b1cdbd2cSJim Jagielski @since UDK 3.2.7
61*b1cdbd2cSJim Jagielski */
62*b1cdbd2cSJim Jagielski inline static Environment getCurrent(rtl::OUString const & typeName = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(CPPU_STRINGIFY(CPPU_ENV)))) SAL_THROW( () );
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski // these are here to force memory de/allocation to sal lib.
65*b1cdbd2cSJim Jagielski /** @internal */
operator new(size_t nSize)66*b1cdbd2cSJim Jagielski inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () )
67*b1cdbd2cSJim Jagielski { return ::rtl_allocateMemory( nSize ); }
68*b1cdbd2cSJim Jagielski /** @internal */
operator delete(void * pMem)69*b1cdbd2cSJim Jagielski inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () )
70*b1cdbd2cSJim Jagielski { ::rtl_freeMemory( pMem ); }
71*b1cdbd2cSJim Jagielski /** @internal */
operator new(size_t,void * pMem)72*b1cdbd2cSJim Jagielski inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () )
73*b1cdbd2cSJim Jagielski { return pMem; }
74*b1cdbd2cSJim Jagielski /** @internal */
operator delete(void *,void *)75*b1cdbd2cSJim Jagielski inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () )
76*b1cdbd2cSJim Jagielski {}
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski /** Constructor: acquires given environment
79*b1cdbd2cSJim Jagielski
80*b1cdbd2cSJim Jagielski @param pEnv environment
81*b1cdbd2cSJim Jagielski */
82*b1cdbd2cSJim Jagielski inline Environment( uno_Environment * pEnv = 0 ) SAL_THROW( () );
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski /** Gets a specific environment. If the specified environment does not exist, then a default one
85*b1cdbd2cSJim Jagielski is created and registered.
86*b1cdbd2cSJim Jagielski
87*b1cdbd2cSJim Jagielski @param envDcp descriptor of the environment
88*b1cdbd2cSJim Jagielski @param pContext context pointer
89*b1cdbd2cSJim Jagielski */
90*b1cdbd2cSJim Jagielski inline explicit Environment( rtl::OUString const & envDcp, void * pContext = NULL ) SAL_THROW( () );
91*b1cdbd2cSJim Jagielski
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski /** Copy constructor: acquires given environment
94*b1cdbd2cSJim Jagielski
95*b1cdbd2cSJim Jagielski @param rEnv another environment
96*b1cdbd2cSJim Jagielski */
97*b1cdbd2cSJim Jagielski inline Environment( const Environment & rEnv ) SAL_THROW( () );
98*b1cdbd2cSJim Jagielski
99*b1cdbd2cSJim Jagielski /** Destructor: releases a set environment.
100*b1cdbd2cSJim Jagielski */
101*b1cdbd2cSJim Jagielski inline ~Environment() SAL_THROW( () );
102*b1cdbd2cSJim Jagielski
103*b1cdbd2cSJim Jagielski /** Sets a given environment, i.e. acquires given one and releases a set one.
104*b1cdbd2cSJim Jagielski
105*b1cdbd2cSJim Jagielski @param pEnv another environment
106*b1cdbd2cSJim Jagielski @return this environment
107*b1cdbd2cSJim Jagielski */
108*b1cdbd2cSJim Jagielski inline Environment & SAL_CALL operator = ( uno_Environment * pEnv ) SAL_THROW( () );
109*b1cdbd2cSJim Jagielski /** Sets a given environment, i.e. acquires given one and releases a set one.
110*b1cdbd2cSJim Jagielski
111*b1cdbd2cSJim Jagielski @param rEnv another environment
112*b1cdbd2cSJim Jagielski @return this environment
113*b1cdbd2cSJim Jagielski */
operator =(const Environment & rEnv)114*b1cdbd2cSJim Jagielski inline Environment & SAL_CALL operator = ( const Environment & rEnv ) SAL_THROW( () )
115*b1cdbd2cSJim Jagielski { return operator = ( rEnv._pEnv ); }
116*b1cdbd2cSJim Jagielski
117*b1cdbd2cSJim Jagielski /** Provides UNacquired pointer to the set C environment.
118*b1cdbd2cSJim Jagielski
119*b1cdbd2cSJim Jagielski @return UNacquired pointer to the C environment struct
120*b1cdbd2cSJim Jagielski */
get() const121*b1cdbd2cSJim Jagielski inline uno_Environment * SAL_CALL get() const SAL_THROW( () )
122*b1cdbd2cSJim Jagielski { return _pEnv; }
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski /** Gets type name of set environment.
125*b1cdbd2cSJim Jagielski
126*b1cdbd2cSJim Jagielski @return type name of set environment
127*b1cdbd2cSJim Jagielski */
getTypeName() const128*b1cdbd2cSJim Jagielski inline ::rtl::OUString SAL_CALL getTypeName() const SAL_THROW( () )
129*b1cdbd2cSJim Jagielski { return _pEnv->pTypeName; }
130*b1cdbd2cSJim Jagielski
131*b1cdbd2cSJim Jagielski /** Gets free context pointer of set environment.
132*b1cdbd2cSJim Jagielski
133*b1cdbd2cSJim Jagielski @return free context pointer of set environment
134*b1cdbd2cSJim Jagielski */
getContext() const135*b1cdbd2cSJim Jagielski inline void * SAL_CALL getContext() const SAL_THROW( () )
136*b1cdbd2cSJim Jagielski { return _pEnv->pContext; }
137*b1cdbd2cSJim Jagielski
138*b1cdbd2cSJim Jagielski /** Tests if a environment is set.
139*b1cdbd2cSJim Jagielski
140*b1cdbd2cSJim Jagielski @return true, if a environment is set, false otherwise
141*b1cdbd2cSJim Jagielski */
is() const142*b1cdbd2cSJim Jagielski inline sal_Bool SAL_CALL is() const SAL_THROW( () )
143*b1cdbd2cSJim Jagielski { return (_pEnv != 0); }
144*b1cdbd2cSJim Jagielski
145*b1cdbd2cSJim Jagielski /** Releases a set environment.
146*b1cdbd2cSJim Jagielski */
147*b1cdbd2cSJim Jagielski inline void SAL_CALL clear() SAL_THROW( () );
148*b1cdbd2cSJim Jagielski
149*b1cdbd2cSJim Jagielski /** Invoke the passed function in this environment.
150*b1cdbd2cSJim Jagielski
151*b1cdbd2cSJim Jagielski @param pCallee the function to call
152*b1cdbd2cSJim Jagielski @param pParam the parameter pointer to be passed to the function
153*b1cdbd2cSJim Jagielski @since UDK 3.2.7
154*b1cdbd2cSJim Jagielski */
155*b1cdbd2cSJim Jagielski inline void SAL_CALL invoke_v(uno_EnvCallee * pCallee, va_list * pParam) const SAL_THROW( () );
156*b1cdbd2cSJim Jagielski
157*b1cdbd2cSJim Jagielski /** Invoke the passed function in this environment.
158*b1cdbd2cSJim Jagielski
159*b1cdbd2cSJim Jagielski @param pCallee the function to call
160*b1cdbd2cSJim Jagielski @param ... the parameters to be passed to the function
161*b1cdbd2cSJim Jagielski @since UDK 3.2.7
162*b1cdbd2cSJim Jagielski */
163*b1cdbd2cSJim Jagielski inline void SAL_CALL invoke(uno_EnvCallee * pCallee, ...) const SAL_THROW( () );
164*b1cdbd2cSJim Jagielski
165*b1cdbd2cSJim Jagielski /** Enter this environment explicitly.
166*b1cdbd2cSJim Jagielski
167*b1cdbd2cSJim Jagielski @since UDK 3.2.7
168*b1cdbd2cSJim Jagielski */
169*b1cdbd2cSJim Jagielski inline void SAL_CALL enter() const SAL_THROW( () );
170*b1cdbd2cSJim Jagielski
171*b1cdbd2cSJim Jagielski /** Checks, if it is valid to currently call objects
172*b1cdbd2cSJim Jagielski belonging to this environment.
173*b1cdbd2cSJim Jagielski
174*b1cdbd2cSJim Jagielski @since UDK 3.2.7
175*b1cdbd2cSJim Jagielski */
176*b1cdbd2cSJim Jagielski inline int SAL_CALL isValid(rtl::OUString * pReason) const SAL_THROW( () );
177*b1cdbd2cSJim Jagielski };
178*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
Environment(uno_Environment * pEnv)179*b1cdbd2cSJim Jagielski inline Environment::Environment( uno_Environment * pEnv ) SAL_THROW( () )
180*b1cdbd2cSJim Jagielski : _pEnv( pEnv )
181*b1cdbd2cSJim Jagielski {
182*b1cdbd2cSJim Jagielski if (_pEnv)
183*b1cdbd2cSJim Jagielski (*_pEnv->acquire)( _pEnv );
184*b1cdbd2cSJim Jagielski }
185*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
Environment(rtl::OUString const & rEnvDcp,void * pContext)186*b1cdbd2cSJim Jagielski inline Environment::Environment( rtl::OUString const & rEnvDcp, void * pContext ) SAL_THROW( () )
187*b1cdbd2cSJim Jagielski : _pEnv(NULL)
188*b1cdbd2cSJim Jagielski {
189*b1cdbd2cSJim Jagielski uno_getEnvironment(&_pEnv, rEnvDcp.pData, pContext);
190*b1cdbd2cSJim Jagielski }
191*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
Environment(const Environment & rEnv)192*b1cdbd2cSJim Jagielski inline Environment::Environment( const Environment & rEnv ) SAL_THROW( () )
193*b1cdbd2cSJim Jagielski : _pEnv( rEnv._pEnv )
194*b1cdbd2cSJim Jagielski {
195*b1cdbd2cSJim Jagielski if (_pEnv)
196*b1cdbd2cSJim Jagielski (*_pEnv->acquire)( _pEnv );
197*b1cdbd2cSJim Jagielski }
198*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
~Environment()199*b1cdbd2cSJim Jagielski inline Environment::~Environment() SAL_THROW( () )
200*b1cdbd2cSJim Jagielski {
201*b1cdbd2cSJim Jagielski if (_pEnv)
202*b1cdbd2cSJim Jagielski (*_pEnv->release)( _pEnv );
203*b1cdbd2cSJim Jagielski }
204*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
clear()205*b1cdbd2cSJim Jagielski inline void Environment::clear() SAL_THROW( () )
206*b1cdbd2cSJim Jagielski {
207*b1cdbd2cSJim Jagielski if (_pEnv)
208*b1cdbd2cSJim Jagielski {
209*b1cdbd2cSJim Jagielski (*_pEnv->release)( _pEnv );
210*b1cdbd2cSJim Jagielski _pEnv = 0;
211*b1cdbd2cSJim Jagielski }
212*b1cdbd2cSJim Jagielski }
213*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
operator =(uno_Environment * pEnv)214*b1cdbd2cSJim Jagielski inline Environment & Environment::operator = ( uno_Environment * pEnv ) SAL_THROW( () )
215*b1cdbd2cSJim Jagielski {
216*b1cdbd2cSJim Jagielski if (pEnv != _pEnv)
217*b1cdbd2cSJim Jagielski {
218*b1cdbd2cSJim Jagielski if (pEnv)
219*b1cdbd2cSJim Jagielski (*pEnv->acquire)( pEnv );
220*b1cdbd2cSJim Jagielski if (_pEnv)
221*b1cdbd2cSJim Jagielski (*_pEnv->release)( _pEnv );
222*b1cdbd2cSJim Jagielski _pEnv = pEnv;
223*b1cdbd2cSJim Jagielski }
224*b1cdbd2cSJim Jagielski return *this;
225*b1cdbd2cSJim Jagielski }
226*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
invoke_v(uno_EnvCallee * pCallee,va_list * pParam) const227*b1cdbd2cSJim Jagielski inline void SAL_CALL Environment::invoke_v(uno_EnvCallee * pCallee, va_list * pParam) const SAL_THROW( () )
228*b1cdbd2cSJim Jagielski {
229*b1cdbd2cSJim Jagielski if (_pEnv)
230*b1cdbd2cSJim Jagielski uno_Environment_invoke_v(_pEnv, pCallee, pParam);
231*b1cdbd2cSJim Jagielski }
232*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
invoke(uno_EnvCallee * pCallee,...) const233*b1cdbd2cSJim Jagielski inline void SAL_CALL Environment::invoke(uno_EnvCallee * pCallee, ...) const SAL_THROW( () )
234*b1cdbd2cSJim Jagielski {
235*b1cdbd2cSJim Jagielski if (_pEnv)
236*b1cdbd2cSJim Jagielski {
237*b1cdbd2cSJim Jagielski va_list param;
238*b1cdbd2cSJim Jagielski
239*b1cdbd2cSJim Jagielski va_start(param, pCallee);
240*b1cdbd2cSJim Jagielski uno_Environment_invoke_v(_pEnv, pCallee, ¶m);
241*b1cdbd2cSJim Jagielski va_end(param);
242*b1cdbd2cSJim Jagielski }
243*b1cdbd2cSJim Jagielski
244*b1cdbd2cSJim Jagielski }
245*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
enter() const246*b1cdbd2cSJim Jagielski inline void SAL_CALL Environment::enter() const SAL_THROW( () )
247*b1cdbd2cSJim Jagielski {
248*b1cdbd2cSJim Jagielski uno_Environment_enter(_pEnv);
249*b1cdbd2cSJim Jagielski }
250*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
isValid(rtl::OUString * pReason) const251*b1cdbd2cSJim Jagielski inline int SAL_CALL Environment::isValid(rtl::OUString * pReason) const SAL_THROW( () )
252*b1cdbd2cSJim Jagielski {
253*b1cdbd2cSJim Jagielski return uno_Environment_isValid(_pEnv, (rtl_uString **)pReason);
254*b1cdbd2cSJim Jagielski }
255*b1cdbd2cSJim Jagielski //__________________________________________________________________________________________________
getCurrent(rtl::OUString const & typeName)256*b1cdbd2cSJim Jagielski inline Environment Environment::getCurrent(rtl::OUString const & typeName) SAL_THROW( () )
257*b1cdbd2cSJim Jagielski {
258*b1cdbd2cSJim Jagielski Environment environment;
259*b1cdbd2cSJim Jagielski
260*b1cdbd2cSJim Jagielski uno_Environment * pEnv = NULL;
261*b1cdbd2cSJim Jagielski uno_getCurrentEnvironment(&pEnv, typeName.pData);
262*b1cdbd2cSJim Jagielski environment = pEnv;
263*b1cdbd2cSJim Jagielski if (pEnv)
264*b1cdbd2cSJim Jagielski pEnv->release(pEnv);
265*b1cdbd2cSJim Jagielski
266*b1cdbd2cSJim Jagielski return environment;
267*b1cdbd2cSJim Jagielski }
268*b1cdbd2cSJim Jagielski
269*b1cdbd2cSJim Jagielski }
270*b1cdbd2cSJim Jagielski }
271*b1cdbd2cSJim Jagielski }
272*b1cdbd2cSJim Jagielski }
273*b1cdbd2cSJim Jagielski
274*b1cdbd2cSJim Jagielski #endif
275