LibreOffice: cppu/EnvGuards.hxx Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

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
25
26namespace cppu
27{
35 class EnvGuard
36 {
37 css::uno::Environment m_env;
38
39 public:
40 explicit EnvGuard(css::uno::Environment const & env)
41 {
42 if (env.is())
43 {
44 m_env = css::uno::Environment::getCurrent();
45 env.enter();
46 }
47 }
48
49 ~EnvGuard()
50 {
51 m_env.enter();
52 }
53
58 bool SAL_CALL is() const
59 {
60 return m_env.is();
61 }
62
66 void clear()
67 {
68 if (m_env.is())
69 {
70 m_env.enter();
71 m_env.clear();
72 }
73 }
74 };
75
83 class AntiEnvGuard
84 {
85 css::uno::Environment m_env;
86
87 public:
88 explicit AntiEnvGuard()
89 : m_env(css::uno::Environment::getCurrent())
90 {
91 uno_Environment_enter(NULL);
92 }
93
94 ~AntiEnvGuard()
95 {
96 m_env.enter();
97 }
98 };
99}
100
101#endif
102
103/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
uno_Environment_enter
CPPU_DLLPUBLIC void uno_Environment_enter(uno_Environment *pEnv) SAL_THROW_EXTERN_C()
Enter an environment explicitly.
cppu
Definition: Enterable.hxx:27
com::sun::star
Definition: unotype.hxx:35
cppu::EnvGuard
Environment Guard The provided Environment becomes entered in the constructor and left in the destruc...
Definition: EnvGuards.hxx:36
cppu::EnvGuard::is
bool is() const
Checks if the associated environment is non empty.
Definition: EnvGuards.hxx:58
cppu::EnvGuard::~EnvGuard
~EnvGuard()
Definition: EnvGuards.hxx:49
cppu::EnvGuard::clear
void clear()
Leaves the associated environment and clears the reference.
Definition: EnvGuards.hxx:66
cppu::EnvGuard::EnvGuard
EnvGuard(css::uno::Environment const &env)
Definition: EnvGuards.hxx:40
cppu::AntiEnvGuard
Environment Anti-Guard Any entered Environment becomes left in the constructor and re-entered in the ...
Definition: EnvGuards.hxx:84
cppu::AntiEnvGuard::~AntiEnvGuard
~AntiEnvGuard()
Definition: EnvGuards.hxx:94
cppu::AntiEnvGuard::AntiEnvGuard
AntiEnvGuard()
Definition: EnvGuards.hxx:88
environment.hxx