octave: liboctave/util/action-container.h annotate

annotate liboctave/util/action-container.h @ 30516:cd4e03781ceb stable

action-container.h: size_t requires cstddef.

author	Gene Harvey <gharveymn@gmail.com>
date	Fri, 24 Sep 2021 15:47:17 -0500
parents	32f4357ac8d9
children	796f54d4ddbf

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 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 // Copyright (C) 1993-2021 The Octave Project Developers
27923 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
30516 cd4e03781ceb action-container.h: size_t requires cstddef. Gene Harvey <gharveymn@gmail.com> parents: 29655 diff changeset	31 #include <cstddef>
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	32 #include <functional>
23442 53f5f8231c37 allow most header files to be compiled separately John W. Eaton <jwe@octave.org> parents: 23437 diff changeset	33
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	34 // This class allows registering actions in a list for later
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	35 // execution, either explicitly or when the container goes out of
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	36 // scope.
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	37
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	38 // FIXME: is there a better name for this class?
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	39
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	40 namespace octave
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	41 {
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	42 class
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	43 action_container
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	44 {
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	45 public:
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	46
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	47 // 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	48 // 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	49 class elem
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	50 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	51 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	52
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	53 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	54
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	55 elem (void) { }
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	56
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	57 // No copying!
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	58
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	59 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	60
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	61 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	62
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	63 virtual ~elem (void) = default;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	64
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	65 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	66 };
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	67
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	68 // 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	69
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	70 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	71 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	72 public:
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	73
29251 30a5e691dd9f allow unwind_action functions to be empty and set after object creation John W. Eaton <jwe@octave.org> parents: 29230 diff changeset	74 // 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	75 // 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	76
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	77 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	78 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	79 : 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	80 { }
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	81
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	82 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	83
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	84 private:
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	85
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	86 std::function<void (void)> m_fcn;
23927 e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23747 diff changeset	87 };
e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23747 diff changeset	88
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	89 // An element that stores arbitrary variable, and restores it.
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	90
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	91 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	92 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	93 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	94 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	95
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	96 restore_var_elem (T& ref, const T& val)
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	97 : m_ptr (&ref), m_val (val) { }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	98
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	99 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	100
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	101 restore_var_elem (const restore_var_elem&) = delete;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	102
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	103 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	104
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	105 void run (void) { *m_ptr = m_val; }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	106
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	107 private:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	108
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	109 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	110 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	111
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	112 // 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	113
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	114 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	115 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	116 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	117 public:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	118
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	119 delete_ptr_elem (T *ptr)
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	120 : m_ptr (ptr) { }
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	121
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	122 // No copying!
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	123
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	124 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	125
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	126 delete_ptr_elem operator = (const delete_ptr_elem&) = delete;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	127
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	128 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	129
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	130 private:
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	131
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	132 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	133 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	134
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	135 action_container (void) { }
23437 442fe5b5afb5 new action_container constructors for unwind_protect John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	136
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	137 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	138
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	139 action_container (const action_container&) = delete;
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	140
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	141 action_container& operator = (const action_container&) = delete;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	142
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	143 virtual ~action_container (void) = default;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	144
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	145 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	146 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	147 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	148 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	149 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	150 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	151
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	152 // 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	153 // 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	154 // const are handled properly.
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	155
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	156 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	157 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	158 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	159 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	160 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	161
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	162 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	163 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	164 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	165 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	166 }
e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23747 diff changeset	167
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	168 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	169 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	170 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	171 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	172 }
e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23747 diff changeset	173
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	174 // Call to delete (T*).
23437 442fe5b5afb5 new action_container constructors for unwind_protect John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	175
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	176 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	177 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	178 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	179 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	180 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	181
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	182 // Protect any variable.
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	183 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	184 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	185 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	186 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	187 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	188
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	189 // 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	190 template <typename T>
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	191 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	192 {
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	193 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	194 }
23437 442fe5b5afb5 new action_container constructors for unwind_protect John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	195
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	196 operator bool (void) const { return ! empty (); }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	197
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	198 virtual void run_first (void) = 0;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	199
29572 aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	200 OCTAVE_API void run (std::size_t num);
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	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 run (void) { run (size ()); }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	203
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	204 virtual void discard_first (void) = 0;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	205
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	206 void discard (std::size_t num)
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	207 {
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	208 if (num > size ())
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	209 num = size ();
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	210
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	211 for (std::size_t i = 0; i < num; i++)
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	212 discard_first ();
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	213 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	214
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	215 void discard (void) { discard (size ()); }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	216
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	217 virtual std::size_t size (void) const = 0;
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	218
23747 0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	219 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	220
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	221 protected:
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	222
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25103 diff changeset	223 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	224 };
0b4d1575a2e2 move action_container and event_queue classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 23442 diff changeset	225 }
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	226
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: diff changeset	227 #endif

Mercurial > octave

annotate liboctave/util/action-container.h @ 30516:cd4e03781ceb stable