LibreOffice Module comphelper (master)  1
scopeguard.hxx
Go to the documentation of this file.
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 <sal/config.h>
24 
25 #include <utility>
26 
27 #include <o3tl/deleter.hxx>
28 
29 // For some reason, Android buildbot issues -Werror like this:
30 // In file included from
31 // /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:50:
32 // /home/android/lo/master-android-arm/include/comphelper/scopeguard.hxx:36:14:
33 // error: function 'comphelper::<deduction guide for ScopeGuard><(lambda at
34 // /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:146:34)>'
35 // has internal linkage but is not defined [-Werror,-Wundefined-internal]
36 // explicit ScopeGuard( Func && func ) : m_func( std::move(func) ) {}
37 // ^
38 // /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:146:28:
39 // note: used here
40 // comphelper::ScopeGuard guard([&]() {
41 // ^
42 #ifdef ANDROID
43 #if defined __clang__
44 #pragma clang diagnostic push
45 #pragma clang diagnostic ignored "-Wundefined-internal"
46 #endif
47 #endif
48 
49 
50 namespace comphelper {
51 
54 template <class Func> class ScopeGuard
55 {
56 public:
59  explicit ScopeGuard( Func && func ) : m_func( std::move(func) ) {}
60 
62  {
63  if (m_bDismissed)
64  return;
66  }
67 
71  void dismiss() { m_bDismissed = true; }
72 
73 private:
74  // noncopyable until we have good reasons...
75  ScopeGuard(const ScopeGuard&) = delete;
76  ScopeGuard& operator=(const ScopeGuard&) = delete;
77 
78  Func m_func;
79  bool m_bDismissed = false;
80 };
81 
82 } // namespace comphelper
83 
84 #ifdef ANDROID
85 #if defined __clang__
86 #pragma clang diagnostic pop
87 #endif
88 #endif
89 
90 #endif // ! defined(INCLUDED_COMPHELPER_SCOPEGUARD_HXX)
91 
92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ScopeGuard to ease writing exception-safe code.
Definition: scopeguard.hxx:54
#define suppress_fun_call_w_exception(expr)
ScopeGuard & operator=(const ScopeGuard &)=delete
ScopeGuard(Func &&func)
Definition: scopeguard.hxx:59
void dismiss()
Dismisses the scope guard, i.e.
Definition: scopeguard.hxx:71