LibreOffice LibreOffice 4.2 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EnvGuards.hxx
Go to the documentation of this file.
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
20 #ifndef INCLUDED_cppu_EnvGuards_hxx
21 #define INCLUDED_cppu_EnvGuards_hxx
22
23 #include <uno/environment.hxx>
24 #include <uno/mapping.hxx>
25
26
27 namespace cssuno = com::sun::star::uno;
28
29
30 namespace cppu
31 {
39 class EnvGuard
40 {
41 cssuno::Environment m_env;
42
43 public:
44 explicit EnvGuard(cssuno::Environment const & env)
45 {
46 if (env.is())
47 {
48 m_env = cssuno::Environment::getCurrent();
49 env.enter();
50 }
51 }
52
53 ~EnvGuard()
54 {
55 m_env.enter();
56 }
57
62 sal_Bool SAL_CALL is() const SAL_THROW(())
63 {
64 return m_env.is();
65 }
66
70 void clear()
71 {
72 if (m_env.is())
73 {
74 m_env.enter();
75 m_env.clear();
76 }
77 }
78 };
79
87 class AntiEnvGuard
88 {
89 cssuno::Environment m_env;
90
91 public:
92 explicit AntiEnvGuard()
93 : m_env(cssuno::Environment::getCurrent())
94 {
95 uno_Environment_enter(NULL);
96 }
97
98 ~AntiEnvGuard()
99 {
100 m_env.enter();
101 }
102 };
103 }
104
105 #endif
106
107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::uno::Environment::clear
void clear()
Releases a set environment.
Definition: environment.hxx:199
cppu::EnvGuard
Environment Guard The provided Environment becomes entered in the constructor and left in the destruc...
Definition: EnvGuards.hxx:39
cppu::AntiEnvGuard::~AntiEnvGuard
~AntiEnvGuard()
Definition: EnvGuards.hxx:98
environment.hxx
cppu::EnvGuard::is
sal_Bool is() const
Checks if the associated environment is non empty.
Definition: EnvGuards.hxx:62
cppu::EnvGuard::EnvGuard
EnvGuard(cssuno::Environment const &env)
Definition: EnvGuards.hxx:44
com::sun::star::uno::Environment::getCurrent
static Environment getCurrent(rtl::OUString const &typeName=rtl::OUString(CPPU_STRINGIFY(CPPU_ENV)))
Returns the current Environment.
Definition: environment.hxx:250
cppu::EnvGuard::~EnvGuard
~EnvGuard()
Definition: EnvGuards.hxx:53
mapping.hxx
cppu::EnvGuard::clear
void clear()
Leaves the associated environment and clears the reference.
Definition: EnvGuards.hxx:70
com::sun::star::uno::Environment::enter
void enter() const
Enter this environment explicitly.
Definition: environment.hxx:240
uno_Environment_enter
CPPU_DLLPUBLIC void uno_Environment_enter(uno_Environment *pEnv) SAL_THROW_EXTERN_C()
Enter an environment explicitly.
sal_Bool
unsigned char sal_Bool
Definition: types.h:46
cppu::AntiEnvGuard
Environment Anti-Guard Any entered Environment becomes left in the constructor and re-entered in the ...
Definition: EnvGuards.hxx:87
com::sun::star::uno::Environment
C++ wrapper for binary C uno_Environment.
Definition: environment.hxx:45
cppu::AntiEnvGuard::AntiEnvGuard
AntiEnvGuard()
Definition: EnvGuards.hxx:92
SAL_THROW
#define SAL_THROW(exc)
Definition of function throw clause macros.
Definition: types.h:358
com::sun::star::uno::Environment::is
sal_Bool is() const
Tests if a environment is set.
Definition: environment.hxx:136