include/comphelper/scopeguard.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_SCOPEGUARD_HXX
  21 #define INCLUDED_COMPHELPER_SCOPEGUARD_HXX
  22
  23 #include <comphelper/comphelperdllapi.h>
  24
  25 #include <functional>
  26
  27 namespace comphelper {
  28
  29 /** ScopeGuard to ease writing exception-safe code.
  30  */
  31 class COMPHELPER_DLLPUBLIC ScopeGuard
  32 {
  33 public:
  34     /** @param func function object to be executed in dtor
  35         @param excHandling switches whether thrown exceptions in dtor will be
  36                            silently ignored (but OSL_ asserted)
  37     */
  38     template <typename func_type>
  39     explicit ScopeGuard( func_type const & func ) : m_func( func ) {}
  40
  41     ~ScopeGuard();
  42
  43     /** Dismisses the scope guard, i.e. the function won't
  44         be executed.
  45     */
  46     void dismiss();
  47
  48 private:
  49     // noncopyable until we have good reasons...
  50     ScopeGuard(const ScopeGuard&) = delete;
  51     ScopeGuard& operator=(const ScopeGuard&) = delete;
  52
  53     ::std::function<void ()> m_func;
  54 };
  55
  56 } // namespace comphelper
  57
  58 #endif // ! defined(INCLUDED_COMPHELPER_SCOPEGUARD_HXX)
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */