include/cppu/EnvGuards.hxx

   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 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23
  24 #ifndef INCLUDED_CPPU_ENVGUARDS_HXX
  25 #define INCLUDED_CPPU_ENVGUARDS_HXX
  26
  27 #include "uno/environment.hxx"
  28
  29
  30 namespace cppu
  31 {
  32     /** Environment Guard
  33         The provided Environment becomes entered in the constructor and left
  34         in the destructor.
  35         (http://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Environment_Guard)
  36
  37         @since UDK 3.2.7
  38     */
  39     class EnvGuard
  40     {
  41         css::uno::Environment m_env;
  42
  43     public:
  44         explicit EnvGuard(css::uno::Environment const & env)
  45         {
  46             if (env.is())
  47             {
  48                 m_env = css::uno::Environment::getCurrent();
  49                 env.enter();
  50             }
  51         }
  52
  53         ~EnvGuard()
  54         {
  55             m_env.enter();
  56         }
  57
  58         /** Checks if the associated environment is non empty.
  59
  60             @return  0 == empty, 1 == non empty
  61         */
  62         bool SAL_CALL is() const
  63         {
  64             return m_env.is();
  65         }
  66
  67         /** Leaves the associated environment and clears
  68             the reference.
  69         */
  70         void clear()
  71         {
  72             if (m_env.is())
  73             {
  74                 m_env.enter();
  75                 m_env.clear();
  76             }
  77         }
  78     };
  79
  80     /** Environment Anti-Guard
  81         Any entered Environment becomes left in the constructor and re-entered
  82         in the destructor.
  83         (http://wiki.openoffice.org/wiki/Uno/Cpp/Spec/Environment_AntiGuard)
  84
  85         @since UDK 3.2.7
  86     */
  87     class AntiEnvGuard
  88     {
  89         css::uno::Environment m_env;
  90
  91     public:
  92         explicit AntiEnvGuard()
  93             : m_env(css::uno::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: */