octave: liboctave/util/unwind-prot.h annotate

annotate liboctave/util/unwind-prot.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 1993-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27372 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27372 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27372 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27372 diff changeset	7
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	8
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23615 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23615 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	20
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	21 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6109 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23615 diff changeset	23 <https://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	24
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	27 #if ! defined (octave_unwind_prot_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 240 diff changeset	28 #define octave_unwind_prot_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	31
17552 d07d59cc8775 move unwind-protect to liboctave John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	32 #include <cstddef>
d07d59cc8775 move unwind-protect to liboctave John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	33
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	34 #include <stack>
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	35 #include <memory>
240 a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe] jwe parents: 164 diff changeset	36
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	37 #include "action-container.h"
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	38
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	39 namespace octave
2985 aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe] jwe parents: 2847 diff changeset	40 {
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	41 class
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	42 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	43 unwind_protect : public action_container
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	44 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	45 public:
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	46
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	47 unwind_protect (void) : m_lifo () { }
2985 aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe] jwe parents: 2847 diff changeset	48
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	49 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	50
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	51 unwind_protect (const unwind_protect&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	52
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	53 unwind_protect& operator = (const unwind_protect&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	54
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	55 // Destructor should not raise an exception, so all actions
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	56 // registered should be exception-safe. If you're not sure, see
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	57 // unwind_protect_safe.
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	58
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	59 ~unwind_protect (void) { run (); }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	60
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	61 operator bool (void) const { return ! empty (); }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	62
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	63 void run_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	64 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	65 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	66 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	67 // No leak on exception!
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	68 std::unique_ptr<elem> ptr (m_lifo.top ());
8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	69 m_lifo.pop ();
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	70 ptr->run ();
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	71 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	72 }
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	73
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	74 void discard_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	75 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	76 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	77 {
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	78 elem *ptr = m_lifo.top ();
8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	79 m_lifo.pop ();
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	80 delete ptr;
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	81 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	82 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	83
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	84 size_t size (void) const { return m_lifo.size (); }
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	85
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	86 protected:
9376 d58086453171 refactor unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	87
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	88 virtual void add_action (elem *new_elem)
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	89 {
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	90 m_lifo.push (new_elem);
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	91 }
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	92
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	93 std::stack<elem *> m_lifo;
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	94 };
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	95
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	96 // Like unwind_protect, but this one will guard against the possibility
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	97 // of seeing an exception (or interrupt) in the cleanup actions.
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	98 // Not that we can do much about it, but at least we won't crash.
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	99
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	100 class
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	101 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	102 unwind_protect_safe : public unwind_protect
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	103 {
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	104 private:
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	105
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	106 void warn_unhandled_exception (void) const;
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9394 diff changeset	107
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	108 public:
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9394 diff changeset	109
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	110 unwind_protect_safe (void) : unwind_protect () { }
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	111
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	112 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	113
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	114 unwind_protect_safe (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	115
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	116 unwind_protect_safe& operator = (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	117
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	118 ~unwind_protect_safe (void)
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	119 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	120 while (! empty ())
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	121 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	122 try
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	123 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	124 run_first ();
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	125 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	126 catch (...) // Yes, the black hole. Remember we're in a destructor.
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	127 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	128 warn_unhandled_exception ();
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	129 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	130 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	131 }
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	132 };
27372 2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	133
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	134 // In most cases, the following are preferred for efficiency. Some
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	135 // cases may require the flexibility of the general unwind_protect
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	136 // mechanism defined above.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	137
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	138 // Perform action at end of the current scope when unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	139 // object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	140 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	141 // For example:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	142 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	143 // void fcn (int val) { ... }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	144 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	145 // ...
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	146 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	147 // {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	148 // int val = 42;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	149 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	150 // // template parameters, std::bind and std::function provide
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	151 // // flexibility in calling forms:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	152 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	153 // unwind_action act1 (fcn, val);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	154 // unwind_action act2 ([val] (void) { fcn (val); });
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	155 // }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	156 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	157 // NOTE: Don't forget to provide a name for the unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	158 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	159 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	160 // unwind_action /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	161 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	162 // then the destructor for the temporary anonymous object will be
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	163 // called immediately after the object is constructed instead of at
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	164 // the end of teh current scope.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	165
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	166 class unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	167 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	168 public:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	169
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	170 template <typename F, typename... Args>
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	171 unwind_action (F&& fcn, Args&&... args)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	172 : m_fcn (std::bind (fcn, args...))
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	173 { }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	174
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	175 // No copying!
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	176
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	177 unwind_action (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	178
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	179 unwind_action& operator = (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	180
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	181 ~unwind_action (void) { m_fcn (); }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	182
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	183 private:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	184
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	185 std::function<void (void)> m_fcn;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	186 };
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	187
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	188 // Reset a variable value at the end of the current scope when
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	189 // unwind_protect_var object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	190 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	191 // For example:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	192 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	193 // {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	194 // int x = 42;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	195 // unwind_protect_var<int> upv (x); // X will be reset at end of scope
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	196 // x = 13; // Set temporary value.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	197 // }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	198 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	199 // Temporary value may be set at construction:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	200 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	201 // {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	202 // int x = ...;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	203 // unwind_protect_var<int> upv (x, 13); // X will be reset.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	204 // // temporary value is 13.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	205 // }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	206 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	207 // NOTE: Don't forget to provide a name for the unwind_protect_var
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	208 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	209 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	210 // unwind_protect_var<type> /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	211 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	212 // then the destructor for the temporary anonymous object will be
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	213 // called immediately after the object is constructed instead of at
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	214 // the end of teh current scope.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	215 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	216 // FIXME: Once we are able to use C++17, class template argument
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	217 // deduction will allow us to omit the explicit template type from the
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	218 // constructor expression:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	219 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	220 // unwind_protect_var upv (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	221
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	222 template <typename T>
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	223 class unwind_protect_var
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	224 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	225 public:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	226
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	227 // Ensure that the value referenced by REF will be reset when this
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	228 // unwind_protect_var object goes out of scope.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	229
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	230 explicit unwind_protect_var (T& ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	231 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	232 { }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	233
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	234 // Set the value referenced by REF to NEW_VAL and ensure that it
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	235 // will be reset to its original value when this
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	236 // unwind_protect_var object goes out of scope.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	237
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	238 unwind_protect_var (T& ref, const T& new_val)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	239 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	240 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	241 m_ref = new_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	242 }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	243
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	244 // No copying!
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	245
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	246 unwind_protect_var (const unwind_protect_var&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	247
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	248 unwind_protect_var& operator = (const unwind_protect_var&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	249
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	250 ~unwind_protect_var (void)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	251 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	252 m_ref = m_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	253 }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	254
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	255 private:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	256
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	257 T& m_ref;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	258 T m_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	259 };
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	260 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	261
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	262 #endif

Mercurial > octave

annotate liboctave/util/unwind-prot.h @ 27919:1891570abac8