include/comphelper/flagguard.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 #ifndef INCLUDED_COMPHELPER_FLAGGUARD_HXX
  21 #define INCLUDED_COMPHELPER_FLAGGUARD_HXX
  22
  23 #include <comphelper/scopeguard.hxx>
  24
  25
  26 namespace comphelper
  27 {
  28
  29     //= FlagRestorationGuard
  30
  31     class COMPHELPER_DLLPUBLIC FlagRestorationGuard : public ScopeGuard
  32     {
  33     public:
  34         FlagRestorationGuard( bool& i_flagRef, bool i_temporaryValue )
  35             : ScopeGuard(RestoreFlag(i_flagRef))
  36         {
  37             i_flagRef = i_temporaryValue;
  38         }
  39
  40         ~FlagRestorationGuard();
  41
  42     private:
  43         // note: can't store the originalValue in a FlagRestorationGuard member,
  44         // because it will be used from base class dtor
  45         struct RestoreFlag
  46         {
  47             bool & rFlag;
  48             bool originalValue;
  49             RestoreFlag(bool & i_flagRef)
  50                 : rFlag(i_flagRef), originalValue(i_flagRef) {}
  51             void operator()()
  52             {
  53                 rFlag = originalValue;
  54             }
  55         };
  56     };
  57
  58
  59     //= FlagGuard
  60
  61     class COMPHELPER_DLLPUBLIC FlagGuard : public ScopeGuard
  62     {
  63     public:
  64         explicit FlagGuard( bool& i_flagRef )
  65             : ScopeGuard( [&i_flagRef] () { i_flagRef = false; } )
  66         {
  67             i_flagRef = true;
  68         }
  69
  70         ~FlagGuard();
  71     };
  72
  73
  74 } // namespace comphelper
  75
  76
  77 #endif // INCLUDED_COMPHELPER_FLAGGUARD_HXX
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */