LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 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 
25 
26 namespace 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 
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 
84  {
85  css::uno::Environment m_env;
86 
87  public:
88  explicit AntiEnvGuard()
89  : m_env(css::uno::Environment::getCurrent())
90  {
92  }
93 
95  {
96  m_env.enter();
97  }
98  };
99 }
100 
101 #endif
102 
103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
EnvGuard(css::uno::Environment const &env)
Definition: EnvGuards.hxx:40
void clear()
Leaves the associated environment and clears the reference.
Definition: EnvGuards.hxx:66
bool is() const
Checks if the associated environment is non empty.
Definition: EnvGuards.hxx:58
Environment Guard The provided Environment becomes entered in the constructor and left in the destruc...
Definition: EnvGuards.hxx:35
CPPU_DLLPUBLIC void uno_Environment_enter(uno_Environment *pEnv) SAL_THROW_EXTERN_C()
Enter an environment explicitly.
Environment Anti-Guard Any entered Environment becomes left in the constructor and re-entered in the ...
Definition: EnvGuards.hxx:83
~AntiEnvGuard()
Definition: EnvGuards.hxx:94
~EnvGuard()
Definition: EnvGuards.hxx:49
AntiEnvGuard()
Definition: EnvGuards.hxx:88