Line data    Source code

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