annotate liboctave/util/unwind-prot.h @ 29299:20092ae957da

Add discard() as an alias for set() for unwind_actions. * unwind-prot.h (unwind_action, unwind_action_safe): Add new member function discard() which calls set() with no arguments. * unwind-prot.h (unwind_action::run, unwind_action_safe::run): Replace call to set() with call to discard(). * __ftp__.cc (F__ftp_mget__), urlwrite.cc (Furlwrite), url-transfer.cc (base_url_transfer::mget_directory): Replace calls to set() with discard().
author Rik <rik@octave.org>
date Sat, 16 Jan 2021 11:50:42 -0800
parents e274759bcb12
children 7854d5752dd2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
3 // Copyright (C) 1993-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
25
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 20545
diff changeset
26 #if ! defined (octave_unwind_prot_h)
383
0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe]
jwe
parents: 240
diff changeset
27 #define octave_unwind_prot_h 1
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
28
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21141
diff changeset
29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21141
diff changeset
30
17552
d07d59cc8775 move unwind-protect to liboctave
John W. Eaton <jwe@octave.org>
parents: 16892
diff changeset
31 #include <cstddef>
d07d59cc8775 move unwind-protect to liboctave
John W. Eaton <jwe@octave.org>
parents: 16892
diff changeset
32
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
33 #include <stack>
9394
b3ab22ee8544 further improve unwind_protect
Jaroslav Hajek <highegg@gmail.com>
parents: 9384
diff changeset
34 #include <memory>
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 164
diff changeset
35
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
36 #include "action-container.h"
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
37
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
38 namespace octave
2985
aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe]
jwe
parents: 2847
diff changeset
39 {
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
40 class
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
41 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
42 unwind_protect : public action_container
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
43 {
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
44 public:
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
45
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
46 unwind_protect (void) : m_lifo () { }
2985
aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe]
jwe
parents: 2847
diff changeset
47
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
48 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
49
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
50 unwind_protect (const unwind_protect&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
51
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
52 unwind_protect& operator = (const unwind_protect&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
53
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
54 // Destructor should not raise an exception, so all actions
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
55 // registered should be exception-safe. If you're not sure, see
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
56 // unwind_protect_safe.
9394
b3ab22ee8544 further improve unwind_protect
Jaroslav Hajek <highegg@gmail.com>
parents: 9384
diff changeset
57
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
58 ~unwind_protect (void) { run (); }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
59
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
60 operator bool (void) const { return ! empty (); }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
61
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
62 void run_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
63 {
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
64 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
65 {
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
66 // No leak on exception!
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
67 std::unique_ptr<elem> ptr (m_lifo.top ());
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
68 m_lifo.pop ();
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
69 ptr->run ();
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
70 }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
71 }
12122
f4689107dd8c Explicitly disallow copying in some classes.
Pascal Dupuis <Pascal.Dupuis@uclouvain.be>
parents: 11586
diff changeset
72
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
73 void discard_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
74 {
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
75 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
76 {
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
77 elem *ptr = m_lifo.top ();
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
78 m_lifo.pop ();
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
79 delete ptr;
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
80 }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
81 }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
82
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
83 size_t size (void) const { return m_lifo.size (); }
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
84
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
85 protected:
9376
d58086453171 refactor unwind_protect
Jaroslav Hajek <highegg@gmail.com>
parents: 8920
diff changeset
86
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
87 virtual void add_action (elem *new_elem)
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
88 {
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
89 m_lifo.push (new_elem);
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
90 }
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25147
diff changeset
91
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
92 std::stack<elem *> m_lifo;
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
93 };
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
94
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21743
diff changeset
95 // Like unwind_protect, but this one will guard against the possibility
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21743
diff changeset
96 // of seeing an exception (or interrupt) in the cleanup actions.
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21743
diff changeset
97 // Not that we can do much about it, but at least we won't crash.
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
98
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
99 class
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
100 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
101 unwind_protect_safe : public unwind_protect
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
102 {
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
103 private:
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
104
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
105 void warn_unhandled_exception (void) const;
9396
17af7cce7d1b yet more unwind_protect improvements
Jaroslav Hajek <highegg@gmail.com>
parents: 9394
diff changeset
106
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
107 public:
9396
17af7cce7d1b yet more unwind_protect improvements
Jaroslav Hajek <highegg@gmail.com>
parents: 9394
diff changeset
108
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
109 unwind_protect_safe (void) : unwind_protect () { }
9394
b3ab22ee8544 further improve unwind_protect
Jaroslav Hajek <highegg@gmail.com>
parents: 9384
diff changeset
110
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
111 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
112
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
113 unwind_protect_safe (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
114
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
115 unwind_protect_safe& operator = (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
116
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
117 ~unwind_protect_safe (void)
22402
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
118 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
119 while (! empty ())
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
120 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
121 try
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
122 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
123 run_first ();
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
124 }
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
125 catch (...) // Yes, the black hole. Remember we're in a destructor.
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
126 {
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
127 warn_unhandled_exception ();
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
128 }
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
129 }
4caa7b28d183 maint: Style check C++ code in liboctave/
Rik <rik@octave.org>
parents: 22323
diff changeset
130 }
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
131 };
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
132
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
133 // In most cases, the following are preferred for efficiency. Some
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
134 // cases may require the flexibility of the general unwind_protect
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
135 // mechanism defined above.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
136
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
137 // Perform action at end of the current scope when unwind_action
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
138 // object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
139 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
140 // For example:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
141 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
142 // void fcn (int val) { ... }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
143 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
144 // ...
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
145 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
146 // {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
147 // int val = 42;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
148 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
149 // // template parameters, std::bind and std::function provide
28824
a98fd0657e35 Replace unwind_protect with more efficient constructs in liboctave (bug #59192).
Rik <rik@octave.org>
parents: 27971
diff changeset
150 // // flexibility in calling forms (function pointer or lambda):
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
151 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
152 // unwind_action act1 (fcn, val);
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
153 // unwind_action act2 ([val] (void) { fcn (val); });
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
154 // }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
155 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
156 // NOTE: Don't forget to provide a name for the unwind_action
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
157 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
158 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
159 // unwind_action /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
160 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
161 // then the destructor for the temporary anonymous object will be
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
162 // called immediately after the object is constructed instead of at
27971
ec769a7ab9fb fix more spelling errors (bug #57613)
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
163 // the end of the current scope.
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
164
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
165 class OCTAVE_API unwind_action
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
166 {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
167 public:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
168
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
169 unwind_action (void) : m_fcn () { }
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
170
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
171 // FIXME: Do we need to apply std::forward to the arguments to
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
172 // std::bind here?
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
173
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
174 template <typename F, typename... Args>
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
175 unwind_action (F&& fcn, Args&&... args)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
176 : m_fcn (std::bind (fcn, args...))
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
177 { }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
178
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
179 // No copying!
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
180
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
181 unwind_action (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
182
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
183 unwind_action& operator = (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
184
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
185 ~unwind_action (void) { run (); }
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
186
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
187 // FIXME: Do we need to apply std::forward to the arguments to
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
188 // std::bind here?
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
189
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
190 template <typename F, typename... Args>
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
191 void set (F&& fcn, Args&&... args)
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
192 {
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
193 m_fcn = std::bind (fcn, args...);
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
194 }
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
195
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
196 void set (void) { m_fcn = nullptr; }
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
197
29299
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
198 // Alias for set() which is clearer about programmer intention.
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
199 void discard (void) { set (); }
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
200
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
201 void run (void)
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
202 {
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
203 if (m_fcn)
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
204 m_fcn ();
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
205
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
206 // Invalidate so action won't run again when object is deleted.
29299
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
207 discard ();
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 28824
diff changeset
208 }
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
209
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
210 private:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
211
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
212 std::function<void (void)> m_fcn;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
213 };
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
214
29252
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
215 // Like unwind_action, but this one will guard against the possibility
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
216 // of seeing an exception (or interrupt) in the cleanup actions.
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
217 // Not that we can do much about it, but at least we won't crash.
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
218
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
219 class OCTAVE_API unwind_action_safe
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
220 {
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
221 private:
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
222
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
223 void warn_unhandled_exception (void) const;
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
224
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
225 public:
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
226
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
227 unwind_action_safe (void) : m_fcn () { }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
228
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
229 // FIXME: Do we need to apply std::forward to the arguments to
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
230 // std::bind here?
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
231
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
232 template <typename F, typename... Args>
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
233 unwind_action_safe (F&& fcn, Args&&... args)
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
234 : m_fcn (std::bind (fcn, args...))
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
235 { }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
236
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
237 // No copying!
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
238
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
239 unwind_action_safe (const unwind_action_safe&) = delete;
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
240
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
241 unwind_action_safe& operator = (const unwind_action_safe&) = delete;
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
242
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
243 ~unwind_action_safe (void) { run (); }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
244
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
245 // FIXME: Do we need to apply std::forward to the arguments to
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
246 // std::bind here?
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
247
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
248 template <typename F, typename... Args>
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
249 void set (F&& fcn, Args&&... args)
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
250 {
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
251 m_fcn = std::bind (fcn, args...);
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
252 }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
253
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
254 void set (void) { m_fcn = nullptr; }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
255
29299
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
256 // Alias for set() which is clearer about programmer intention.
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
257 void discard (void) { set (); }
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
258
29252
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
259 void run (void)
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
260 {
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
261 try
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
262 {
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
263 if (m_fcn)
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
264 m_fcn ();
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
265 }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
266 catch (...) // Yes, the black hole. Remember we're in a destructor.
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
267 {
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
268 warn_unhandled_exception ();
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
269 }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
270
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
271 // Invalidate so action won't run again when object is deleted.
29299
20092ae957da Add discard() as an alias for set() for unwind_actions.
Rik <rik@octave.org>
parents: 29252
diff changeset
272 discard ();
29252
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
273 }
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
274
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
275 private:
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
276
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
277 std::function<void (void)> m_fcn;
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
278 };
e274759bcb12 new unwind_action class that handles execptions
John W. Eaton <jwe@octave.org>
parents: 29251
diff changeset
279
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
280 // Reset a variable value at the end of the current scope when
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
281 // unwind_protect_var object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
282 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
283 // For example:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
284 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
285 // {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
286 // int x = 42;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
287 // unwind_protect_var<int> upv (x); // X will be reset at end of scope
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
288 // x = 13; // Set temporary value.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
289 // }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
290 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
291 // Temporary value may be set at construction:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
292 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
293 // {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
294 // int x = ...;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
295 // unwind_protect_var<int> upv (x, 13); // X will be reset.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
296 // // temporary value is 13.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
297 // }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
298 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
299 // NOTE: Don't forget to provide a name for the unwind_protect_var
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
300 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
301 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
302 // unwind_protect_var<type> /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
303 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
304 // then the destructor for the temporary anonymous object will be
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
305 // called immediately after the object is constructed instead of at
27971
ec769a7ab9fb fix more spelling errors (bug #57613)
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
306 // the end of the current scope.
27372
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
307 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
308 // FIXME: Once we are able to use C++17, class template argument
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
309 // deduction will allow us to omit the explicit template type from the
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
310 // constructor expression:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
311 //
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
312 // unwind_protect_var upv (...);
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
313
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
314 template <typename T>
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
315 class unwind_protect_var
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
316 {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
317 public:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
318
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
319 // Ensure that the value referenced by REF will be reset when this
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
320 // unwind_protect_var object goes out of scope.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
321
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
322 explicit unwind_protect_var (T& ref)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
323 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
324 { }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
325
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
326 // Set the value referenced by REF to NEW_VAL and ensure that it
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
327 // will be reset to its original value when this
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
328 // unwind_protect_var object goes out of scope.
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
329
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
330 unwind_protect_var (T& ref, const T& new_val)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
331 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
332 {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
333 m_ref = new_val;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
334 }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
335
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
336 // No copying!
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
337
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
338 unwind_protect_var (const unwind_protect_var&) = delete;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
339
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
340 unwind_protect_var& operator = (const unwind_protect_var&) = delete;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
341
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
342 ~unwind_protect_var (void)
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
343 {
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
344 m_ref = m_val;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
345 }
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
346
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
347 private:
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
348
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
349 T& m_ref;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
350 T m_val;
2f8428b61bd6 new single-action unwind-protect classes
John W. Eaton <jwe@octave.org>
parents: 27177
diff changeset
351 };
21743
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
352 }
f4d7d0eb5b0c use namespace for unwind_protect class
John W. Eaton <jwe@octave.org>
parents: 21307
diff changeset
353
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
354 #endif