blob: 9ddcd4b8f09f4cd8ad995421069ede29ecc03399 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* RAII class for executing arbitrary actions at scope end. */
#ifndef mozilla_ScopeExit_h
#define mozilla_ScopeExit_h
/*
* See http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189.pdf for a
* standards-track version of this.
*
* Error handling can be complex when various actions need to be performed that
* need to be undone if an error occurs midway. This can be handled with a
* collection of boolean state variables and gotos, which can get clunky and
* error-prone:
*
* {
* if (!a.setup())
* goto fail;
* isASetup = true;
*
* if (!b.setup())
* goto fail;
* isBSetup = true;
*
* ...
* return true;
*
* fail:
* if (isASetup)
* a.teardown();
* if (isBSetup)
* b.teardown();
* return false;
* }
*
* ScopeExit is a mechanism to simplify this pattern by keeping an RAII guard
* class that will perform the teardown on destruction, unless released. So the
* above would become:
*
* {
* if (!a.setup()) {
* return false;
* }
* auto guardA = MakeScopeExit([&] {
* a.teardown();
* });
*
* if (!b.setup()) {
* return false;
* }
* auto guardB = MakeScopeExit([&] {
* b.teardown();
* });
*
* ...
* guardA.release();
* guardB.release();
* return true;
* }
*
* This header provides:
*
* - |ScopeExit| - a container for a cleanup call, automically called at the
* end of the scope;
* - |MakeScopeExit| - a convenience function for constructing a |ScopeExit|
* with a given cleanup routine, commonly used with a lambda function.
*
* Note that the RAII classes defined in this header do _not_ perform any form
* of reference-counting or garbage-collection. These classes have exactly two
* behaviors:
*
* - if |release()| has not been called, the cleanup is always performed at
* the end of the scope;
* - if |release()| has been called, nothing will happen at the end of the
* scope.
*/
#include <utility>
#include "mozilla/Attributes.h"
namespace mozilla {
template <typename ExitFunction>
class MOZ_STACK_CLASS ScopeExit {
ExitFunction mExitFunction;
bool mExecuteOnDestruction;
public:
explicit ScopeExit(ExitFunction&& cleanup)
: mExitFunction(std::move(cleanup)), mExecuteOnDestruction(true) {}
ScopeExit(ScopeExit&& rhs)
: mExitFunction(std::move(rhs.mExitFunction)),
mExecuteOnDestruction(rhs.mExecuteOnDestruction) {
rhs.release();
}
~ScopeExit() {
if (mExecuteOnDestruction) {
mExitFunction();
}
}
void release() { mExecuteOnDestruction = false; }
private:
explicit ScopeExit(const ScopeExit&) = delete;
ScopeExit& operator=(const ScopeExit&) = delete;
ScopeExit& operator=(ScopeExit&&) = delete;
};
template <typename ExitFunction>
[[nodiscard]] ScopeExit<ExitFunction> MakeScopeExit(
ExitFunction&& exitFunction) {
return ScopeExit<ExitFunction>(std::move(exitFunction));
}
} /* namespace mozilla */
#endif /* mozilla_ScopeExit_h */
|
