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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/////////////////////////////////////////////////////////////////////////////
// Name: scopeguard.h
// Purpose: interface of global functions
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxScopeGuard
Scope guard is an object which allows executing an action on scope exit.
The objects of this class must be constructed using wxMakeGuard() function.
@nolibrary
@category{misc}
*/
class wxScopeGuard
{
public:
/**
Call this method to dismiss the execution of the action on scope exit.
A typical example:
@code
Update1();
// ensure that changes done so far are rolled back if the next
// operation throws
wxScopeGuard guard = wxMakeGuard(RollBack);
Update2();
// it didn't throw so commit the changes, i.e. avoid rolling back
guard.Dismiss();
@endcode
*/
void Dismiss();
};
/** @addtogroup group_funcmacro_misc */
//@{
/**
Returns a scope guard object which will call the specified function with
the given parameters on scope exit.
This function is overloaded to take several parameters up to some
implementation-defined (but relatively low) limit.
The @a func should be a functor taking parameters of the types P1, ..., PN,
i.e. the expression @c func(p1, ..., pN) should be valid.
*/
template <typename F, typename P1, ..., typename PN>
wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
//@}
/** @addtogroup group_funcmacro_misc */
//@{
/**
Ensure that the global @a function with a few (up to some
implementation-defined limit) is executed on scope exit, whether due to a
normal function return or because an exception has been thrown.
A typical example of its usage:
@code
void *buf = malloc(size);
wxON_BLOCK_EXIT1(free, buf);
@endcode
Please see the original article by Andrei Alexandrescu and Petru Marginean
published in December 2000 issue of C/C++ Users Journal for more details.
@see wxON_BLOCK_EXIT_OBJ0()
@header{wx/scopeguard.h}
*/
#define wxON_BLOCK_EXIT(function, ...)
#define wxON_BLOCK_EXIT0(function)
#define wxON_BLOCK_EXIT1(function, p1)
#define wxON_BLOCK_EXIT2(function, p1, p2)
#define wxON_BLOCK_EXIT3(function, p1, p2, p3)
//@}
/** @addtogroup group_funcmacro_misc */
//@{
/**
This family of macros is similar to wxON_BLOCK_EXIT(), but calls a method
of the given object instead of a free function.
@header{wx/scopeguard.h}
*/
#define wxON_BLOCK_EXIT_OBJ(object, method, ...)
#define wxON_BLOCK_EXIT_OBJ0(object, method)
#define wxON_BLOCK_EXIT_OBJ1(object, method, p1)
#define wxON_BLOCK_EXIT_OBJ2(object, method, p1, p2)
#define wxON_BLOCK_EXIT_OBJ3(object, method, p1, p2, p3)
//@}
/** @addtogroup group_funcmacro_misc */
//@{
/**
This family of macros is similar to wxON_BLOCK_OBJ(), but calls a method
of @c this object instead of a method of the specified object.
@header{wx/scopeguard.h}
*/
#define wxON_BLOCK_EXIT_THIS(method, ...)
#define wxON_BLOCK_EXIT_THIS0(method)
#define wxON_BLOCK_EXIT_THIS1(method, p1)
#define wxON_BLOCK_EXIT_THIS2(method, p1, p2)
#define wxON_BLOCK_EXIT_THIS3(method, p1, p2, p3)
//@}
/** @addtogroup group_funcmacro_misc */
//@{
/**
This macro sets a variable to the specified value on scope exit.
Example of usage:
@code
void foo()
{
bool isDoingSomething = true;
{
wxON_BLOCK_EXIT_SET(isDoingSomething, false);
... do something ...
}
... isDoingSomething is false now ...
}
@endcode
Notice that @a value is copied, i.e. stored by value, so it can be a
temporary object returned by a function call, for example.
@see wxON_BLOCK_EXIT_OBJ0(), wxON_BLOCK_EXIT_NULL()
@header{wx/scopeguard.h}
*/
#define wxON_BLOCK_EXIT_SET(var, value)
/**
This macro sets the pointer passed to it as argument to NULL on scope exit.
It must be used instead of wxON_BLOCK_EXIT_SET() when the value being set
is @c NULL.
@header{wx/scopeguard.h}
*/
#define wxON_BLOCK_EXIT_NULL(ptr)
//@}
|
