annotate liboctave/util/action-container.h @ 29251:30a5e691dd9f

allow unwind_action functions to be empty and set after object creation * unwind-prot.h (unwind_action::unwind_action): New overload that allows unwind_action to be created without a valid function. (unwind_action::set): New functions. Allow action to be changed or set to an invalid function. (unwind_action::run): New function. Skip action if it is invalid. (unwind_action::~unwind_action): Use run to execute action.
author John W. Eaton <jwe@octave.org>
date Sun, 03 Jan 2021 14:37:13 -0500
parents 6b3faa844395
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 ////////////////////////////////////////////////////////////////////////
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
26 #if ! defined (octave_action_container_h)
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 #define octave_action_container_h 1
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21139
diff changeset
29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21139
diff changeset
30
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
31 #include <functional>
23442
53f5f8231c37 allow most header files to be compiled separately
John W. Eaton <jwe@octave.org>
parents: 23437
diff changeset
32
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 // This class allows registering actions in a list for later
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 // execution, either explicitly or when the container goes out of
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 // scope.
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
17769
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/
Rik <rik@octave.org>
parents: 17744
diff changeset
37 // FIXME: is there a better name for this class?
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
39 namespace octave
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 {
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
41 class
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
42 action_container
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 {
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 public:
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
45
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
46 // A generic unwind_protect element. Knows how to run itself and
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
47 // discard itself. Also, contains a pointer to the next element.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
48 class elem
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
49 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
50 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
51
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
52 friend class action_container;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
53
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
54 elem (void) { }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
55
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
56 // No copying!
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
58 elem (const elem&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
59
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
60 elem& operator = (const elem&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
61
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
62 virtual ~elem (void) = default;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
64 virtual void run (void) { }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
65 };
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
66
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
67 // An element that merely runs a void (*)(void) function.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
68
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
69 class fcn_elem : public elem
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
70 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
71 public:
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
72
29251
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 29230
diff changeset
73 // 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: 29230
diff changeset
74 // std::bind here?
30a5e691dd9f allow unwind_action functions to be empty and set after object creation
John W. Eaton <jwe@octave.org>
parents: 29230
diff changeset
75
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
76 template <typename F, typename... Args>
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
77 fcn_elem (F&& fcn, Args&&... args)
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
78 : m_fcn (std::bind (fcn, args...))
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
79 { }
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
80
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
81 void run (void) { m_fcn (); }
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
82
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
83 private:
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
84
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
85 std::function<void (void)> m_fcn;
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
86 };
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
87
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
88 // An element that stores arbitrary variable, and restores it.
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
89
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
90 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
91 class restore_var_elem : public elem
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
92 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
93 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
94
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
95 restore_var_elem (T& ref, const T& val)
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
96 : m_ptr (&ref), m_val (val) { }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
97
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
98 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
99
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
100 restore_var_elem (const restore_var_elem&) = delete;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
101
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
102 restore_var_elem& operator = (const restore_var_elem&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
103
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
104 void run (void) { *m_ptr = m_val; }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
106 private:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
107
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
108 T *m_ptr, m_val;
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
109 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
110
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
111 // Deletes a class allocated using new.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
112
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
113 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
114 class delete_ptr_elem : public elem
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
115 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
116 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
117
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
118 delete_ptr_elem (T *ptr)
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
119 : m_ptr (ptr) { }
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
120
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
121 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
122
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
123 delete_ptr_elem (const delete_ptr_elem&) = delete;
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
124
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
125 delete_ptr_elem operator = (const delete_ptr_elem&) = delete;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
126
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
127 void run (void) { delete m_ptr; }
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
128
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
129 private:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
130
27177
8498dccc15c7 minor style fixes
John W. Eaton <jwe@octave.org>
parents: 26377
diff changeset
131 T *m_ptr;
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
132 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
133
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
134 action_container (void) { }
23437
442fe5b5afb5 new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
135
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
136 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
137
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
138 action_container (const action_container&) = delete;
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22868
diff changeset
139
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
140 action_container& operator = (const action_container&) = delete;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
141
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
142 virtual ~action_container (void) = default;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
143
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
144 template <typename F, typename... Args>
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
145 void add (F&& fcn, Args&&... args)
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
146 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
147 add_action (new fcn_elem (std::forward<F> (fcn),
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
148 std::forward<Args> (args)...));
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
149 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
150
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
151 // Use separate template types for function pointer parameter
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
152 // declarations and captured arguments so that differences in
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
153 // const are handled properly.
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
154
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
155 template <typename... Params, typename... Args>
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
156 void add_fcn (void (*fcn) (Params...), Args&&... args)
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
157 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
158 add_action (new fcn_elem (fcn, std::forward<Args> (args)...));
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
159 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
160
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
161 template <typename T, typename... Params, typename... Args>
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
162 void add_method (T *obj, void (T::*method) (Params...), Args&&... args)
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
163 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
164 add_action (new fcn_elem (method, obj, std::forward<Args> (args)...));
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
165 }
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
166
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
167 template <typename T, typename... Params, typename... Args>
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
168 void add_method (T& obj, void (T::*method) (Params...), Args&&... args)
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
169 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
170 add_action (new fcn_elem (method, &obj, std::forward<Args> (args)...));
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
171 }
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23747
diff changeset
172
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
173 // Call to delete (T*).
23437
442fe5b5afb5 new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
174
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
175 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
176 void add_delete (T *obj)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
177 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
178 add_action (new delete_ptr_elem<T> (obj));
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
179 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
180
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
181 // Protect any variable.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
182 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
183 void protect_var (T& var)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
184 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
185 add_action (new restore_var_elem<T> (var, var));
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
186 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
187
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
188 // Protect any variable, value given.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
189 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
190 void protect_var (T& var, const T& val)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
191 {
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
192 add_action (new restore_var_elem<T> (var, val));
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
193 }
23437
442fe5b5afb5 new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
194
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
195 operator bool (void) const { return ! empty (); }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
196
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
197 virtual void run_first (void) = 0;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
198
29230
6b3faa844395 Set API tags in files in liboctave/util (patch #8919).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27923
diff changeset
199 OCTAVE_API void run (size_t num);
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
200
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
201 void run (void) { run (size ()); }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
202
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
203 virtual void discard_first (void) = 0;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
204
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
205 void discard (size_t num)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
206 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
207 if (num > size ())
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
208 num = size ();
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
209
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
210 for (size_t i = 0; i < num; i++)
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
211 discard_first ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
212 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
213
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
214 void discard (void) { discard (size ()); }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
215
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
216 virtual size_t size (void) const = 0;
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
217
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
218 bool empty (void) const { return size () == 0; }
25653
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
219
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
220 protected:
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
221
b3d357990b52 better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents: 25103
diff changeset
222 virtual void add_action (elem *new_elem) = 0;
23747
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
223 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23442
diff changeset
224 }
15396
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
225
1054ab58cd58 abstract unwind_protect
John W. Eaton <jwe@octave.org>
parents:
diff changeset
226 #endif