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