Mercurial > octave
annotate liboctave/util/action-container.h @ 29230:6b3faa844395
Set API tags in files in liboctave/util (patch #8919).
Add API tag to template class definitions. Add API tag to (un-defined) functions
and member functions in headers. Export template class instantiations and
template functions from .cc files.
author | Markus Mützel <markus.muetzel@gmx.de> |
---|---|
date | Tue, 29 Dec 2020 17:58:57 +0100 |
parents | bd51beb6205e |
children | 30a5e691dd9f |
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 | 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 | 27 #define octave_action_container_h 1 |
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 | 33 // This class allows registering actions in a list for later |
34 // execution, either explicitly or when the container goes out of | |
35 // scope. | |
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 | 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 | 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 | 43 { |
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 | 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 | 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 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
73 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
|
74 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
|
75 : 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
|
76 { } |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
77 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
78 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
|
79 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
80 private: |
15396 | 81 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
82 std::function<void (void)> m_fcn; |
23927
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23747
diff
changeset
|
83 }; |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23747
diff
changeset
|
84 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
85 // An element that stores arbitrary variable, and restores it. |
15396 | 86 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
87 template <typename T> |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
88 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
|
89 { |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
90 public: |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
91 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
92 restore_var_elem (T& ref, const T& val) |
27177 | 93 : m_ptr (&ref), m_val (val) { } |
15396 | 94 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
95 // No copying! |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
96 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
97 restore_var_elem (const restore_var_elem&) = delete; |
15396 | 98 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
99 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
|
100 |
27177 | 101 void run (void) { *m_ptr = m_val; } |
15396 | 102 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
103 private: |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
104 |
27177 | 105 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
|
106 }; |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
107 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
108 // 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
|
109 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
110 template <typename T> |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
111 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
|
112 { |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
113 public: |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
114 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
115 delete_ptr_elem (T *ptr) |
27177 | 116 : m_ptr (ptr) { } |
22869
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
117 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
118 // No copying! |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
119 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
120 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
|
121 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
122 delete_ptr_elem operator = (const delete_ptr_elem&) = delete; |
15396 | 123 |
27177 | 124 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
|
125 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
126 private: |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
127 |
27177 | 128 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
|
129 }; |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
130 |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
131 action_container (void) { } |
23437
442fe5b5afb5
new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
132 |
22869
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
133 // No copying! |
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
134 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
135 action_container (const action_container&) = delete; |
22869
f75d289645ec
make deleted functions public
John W. Eaton <jwe@octave.org>
parents:
22868
diff
changeset
|
136 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
137 action_container& operator = (const action_container&) = delete; |
15396 | 138 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
139 virtual ~action_container (void) = default; |
15396 | 140 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
141 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
|
142 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
|
143 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
144 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
|
145 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
|
146 } |
15396 | 147 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
148 // 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
|
149 // 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
|
150 // const are handled properly. |
15396 | 151 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
152 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
|
153 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
|
154 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
155 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
|
156 } |
15396 | 157 |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
158 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
|
159 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
|
160 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
161 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
|
162 } |
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 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
|
165 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
|
166 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
167 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
|
168 } |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23747
diff
changeset
|
169 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
170 // Call to delete (T*). |
23437
442fe5b5afb5
new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
171 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
172 template <typename T> |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
173 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
|
174 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
175 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
|
176 } |
15396 | 177 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
178 // Protect any variable. |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
179 template <typename T> |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
180 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
|
181 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
182 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
|
183 } |
15396 | 184 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
185 // 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
|
186 template <typename T> |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
187 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
|
188 { |
25653
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
189 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
|
190 } |
23437
442fe5b5afb5
new action_container constructors for unwind_protect
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
191 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
192 operator bool (void) const { return ! empty (); } |
15396 | 193 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
194 virtual void run_first (void) = 0; |
15396 | 195 |
29230
6b3faa844395
Set API tags in files in liboctave/util (patch #8919).
Markus Mützel <markus.muetzel@gmx.de>
parents:
27923
diff
changeset
|
196 OCTAVE_API void run (size_t num); |
15396 | 197 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
198 void run (void) { run (size ()); } |
15396 | 199 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
200 virtual void discard_first (void) = 0; |
15396 | 201 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
202 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
|
203 { |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
204 if (num > size ()) |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
205 num = size (); |
15396 | 206 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
207 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
|
208 discard_first (); |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
209 } |
15396 | 210 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
211 void discard (void) { discard (size ()); } |
15396 | 212 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
213 virtual size_t size (void) const = 0; |
15396 | 214 |
23747
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
215 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
|
216 |
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
217 protected: |
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
218 |
b3d357990b52
better use of templates for action_container and derived classes
John W. Eaton <jwe@octave.org>
parents:
25103
diff
changeset
|
219 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
|
220 }; |
0b4d1575a2e2
move action_container and event_queue classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
23442
diff
changeset
|
221 } |
15396 | 222 |
223 #endif |