cppu/inc/uno/environment.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: environment.hxx,v $
  10  * $Revision: 1.10 $
  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_ENVIRONMENT_HXX_
  31 #define _UNO_ENVIRONMENT_HXX_
  32
  33 #include <rtl/alloc.h>
  34 #include <rtl/ustring.hxx>
  35 #include <uno/environment.h>
  36
  37 #include "uno/lbnames.h"
  38
  39 /** */ //for docpp
  40 namespace com
  41 {
  42 /** */ //for docpp
  43 namespace sun
  44 {
  45 /** */ //for docpp
  46 namespace star
  47 {
  48 /** */ //for docpp
  49 namespace uno
  50 {
  51
  52 /** C++ wrapper for binary C uno_Environment.
  53
  54     @see uno_Environment
  55 */
  56 class Environment
  57 {
  58     /** binary C uno_Environment
  59     */
  60     uno_Environment * _pEnv;
  61
  62 public:
  63     /** Returns the current Environment.
  64
  65         @param env_type   the optional type of the Environment, falls back to "uno" in case being empty,
  66                           respectively to current C++ Environment.
  67         @since UDK 3.2.7
  68     */
  69     inline static Environment getCurrent(rtl::OUString const & typeName = rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(CPPU_STRINGIFY(CPPU_ENV)))) SAL_THROW( () );
  70
  71     // these are here to force memory de/allocation to sal lib.
  72     /** @internal */
  73     inline static void * SAL_CALL operator new ( size_t nSize ) SAL_THROW( () )
  74         { return ::rtl_allocateMemory( nSize ); }
  75     /** @internal */
  76     inline static void SAL_CALL operator delete ( void * pMem ) SAL_THROW( () )
  77         { ::rtl_freeMemory( pMem ); }
  78     /** @internal */
  79     inline static void * SAL_CALL operator new ( size_t, void * pMem ) SAL_THROW( () )
  80         { return pMem; }
  81     /** @internal */
  82     inline static void SAL_CALL operator delete ( void *, void * ) SAL_THROW( () )
  83         {}
  84
  85     /** Constructor: acquires given environment
  86
  87         @param pEnv environment
  88     */
  89     inline Environment( uno_Environment * pEnv = 0 ) SAL_THROW( () );
  90
  91     /** Gets a specific environment. If the specified environment does not exist, then a default one
  92         is created and registered.
  93
  94         @param envDcp           descriptor of the environment
  95         @param pContext         context pointer
  96     */
  97     inline explicit Environment( rtl::OUString const & envDcp, void * pContext = NULL ) SAL_THROW( () );
  98
  99
 100     /** Copy constructor: acquires given environment
 101
 102         @param rEnv another environment
 103     */
 104     inline Environment( const Environment & rEnv ) SAL_THROW( () );
 105
 106     /** Destructor: releases a set environment.
 107     */
 108     inline ~Environment() SAL_THROW( () );
 109
 110     /** Sets a given environment, i.e. acquires given one and releases a set one.
 111
 112         @param pEnv another environment
 113         @return this environment
 114     */
 115     inline Environment & SAL_CALL operator = ( uno_Environment * pEnv ) SAL_THROW( () );
 116     /** Sets a given environment, i.e. acquires given one and releases a set one.
 117
 118         @param rEnv another environment
 119         @return this environment
 120     */
 121     inline Environment & SAL_CALL operator = ( const Environment & rEnv ) SAL_THROW( () )
 122         { return operator = ( rEnv._pEnv ); }
 123
 124     /** Provides UNacquired pointer to the set C environment.
 125
 126         @return UNacquired pointer to the C environment struct
 127     */
 128     inline uno_Environment * SAL_CALL get() const SAL_THROW( () )
 129         { return _pEnv; }
 130
 131     /** Gets type name of set environment.
 132
 133         @return type name of set environment
 134     */
 135     inline ::rtl::OUString SAL_CALL getTypeName() const SAL_THROW( () )
 136         { return _pEnv->pTypeName; }
 137
 138     /** Gets free context pointer of set environment.
 139
 140         @return free context pointer of set environment
 141     */
 142     inline void * SAL_CALL getContext() const SAL_THROW( () )
 143         { return _pEnv->pContext; }
 144
 145     /** Tests if a environment is set.
 146
 147         @return true, if a environment is set, false otherwise
 148     */
 149     inline sal_Bool SAL_CALL is() const SAL_THROW( () )
 150         { return (_pEnv != 0); }
 151
 152     /** Releases a set environment.
 153     */
 154     inline void SAL_CALL clear() SAL_THROW( () );
 155
 156     /** Invoke the passed function in this environment.
 157
 158         @param pCallee  the function to call
 159         @param pParam   the parameter pointer to be passed to the function
 160         @since UDK 3.2.7
 161     */
 162     inline void SAL_CALL invoke_v(uno_EnvCallee * pCallee, va_list * pParam) const SAL_THROW( () );
 163
 164     /** Invoke the passed function in this environment.
 165
 166         @param pCallee  the function to call
 167         @param ...      the parameters to be passed to the function
 168         @since UDK 3.2.7
 169     */
 170     inline void SAL_CALL invoke(uno_EnvCallee * pCallee, ...) const SAL_THROW( () );
 171
 172     /** Enter this environment explicitly.
 173
 174         @since UDK 3.2.7
 175     */
 176     inline void SAL_CALL enter() const SAL_THROW( () );
 177
 178     /** Checks, if it is valid to currently call objects
 179         belonging to this environment.
 180
 181         @since UDK 3.2.7
 182     */
 183     inline int  SAL_CALL isValid(rtl::OUString * pReason) const SAL_THROW( () );
 184 };
 185 //__________________________________________________________________________________________________
 186 inline Environment::Environment( uno_Environment * pEnv ) SAL_THROW( () )
 187     : _pEnv( pEnv )
 188 {
 189     if (_pEnv)
 190         (*_pEnv->acquire)( _pEnv );
 191 }
 192 //__________________________________________________________________________________________________
 193 inline Environment::Environment( rtl::OUString const & rEnvDcp, void * pContext ) SAL_THROW( () )
 194     : _pEnv(NULL)
 195 {
 196     uno_getEnvironment(&_pEnv, rEnvDcp.pData, pContext);
 197 }
 198 //__________________________________________________________________________________________________
 199 inline Environment::Environment( const Environment & rEnv ) SAL_THROW( () )
 200     : _pEnv( rEnv._pEnv )
 201 {
 202     if (_pEnv)
 203         (*_pEnv->acquire)( _pEnv );
 204 }
 205 //__________________________________________________________________________________________________
 206 inline Environment::~Environment() SAL_THROW( () )
 207 {
 208     if (_pEnv)
 209         (*_pEnv->release)( _pEnv );
 210 }
 211 //__________________________________________________________________________________________________
 212 inline void Environment::clear() SAL_THROW( () )
 213 {
 214     if (_pEnv)
 215     {
 216         (*_pEnv->release)( _pEnv );
 217         _pEnv = 0;
 218     }
 219 }
 220 //__________________________________________________________________________________________________
 221 inline Environment & Environment::operator = ( uno_Environment * pEnv ) SAL_THROW( () )
 222 {
 223     if (pEnv != _pEnv)
 224     {
 225         if (pEnv)
 226             (*pEnv->acquire)( pEnv );
 227         if (_pEnv)
 228             (*_pEnv->release)( _pEnv );
 229         _pEnv = pEnv;
 230     }
 231     return *this;
 232 }
 233 //__________________________________________________________________________________________________
 234 inline void SAL_CALL Environment::invoke_v(uno_EnvCallee * pCallee, va_list * pParam) const SAL_THROW( () )
 235 {
 236     if (_pEnv)
 237         uno_Environment_invoke_v(_pEnv, pCallee, pParam);
 238 }
 239 //__________________________________________________________________________________________________
 240 inline void SAL_CALL Environment::invoke(uno_EnvCallee * pCallee, ...) const SAL_THROW( () )
 241 {
 242     if (_pEnv)
 243     {
 244         va_list param;
 245
 246         va_start(param, pCallee);
 247         uno_Environment_invoke_v(_pEnv, pCallee, &param);
 248         va_end(param);
 249     }
 250
 251 }
 252 //__________________________________________________________________________________________________
 253 inline void SAL_CALL Environment::enter() const SAL_THROW( () )
 254 {
 255     uno_Environment_enter(_pEnv);
 256 }
 257 //__________________________________________________________________________________________________
 258 inline int  SAL_CALL Environment::isValid(rtl::OUString * pReason) const SAL_THROW( () )
 259 {
 260     return uno_Environment_isValid(_pEnv, (rtl_uString **)pReason);
 261 }
 262 //__________________________________________________________________________________________________
 263 inline Environment Environment::getCurrent(rtl::OUString const & typeName) SAL_THROW( () )
 264 {
 265     Environment environment;
 266
 267     uno_Environment * pEnv = NULL;
 268     uno_getCurrentEnvironment(&pEnv, typeName.pData);
 269     environment = pEnv;
 270     if (pEnv)
 271         pEnv->release(pEnv);
 272
 273     return environment;
 274 }
 275
 276 }
 277 }
 278 }
 279 }
 280
 281 #endif