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

annotate liboctave/util/unwind-prot.h @ 29654:d13d090cb03a stable

use std::size_t and std::ptrdiff_t in C++ code (bug #60471) Files affected: make_int.cc, file-editor-tab.cc, octave-qscintilla.cc, Cell.cc, Cell.h, call-stack.cc, call-stack.h, cellfun.cc, data.cc, debug.cc, dlmread.cc, error.cc, event-queue.h, fcn-info.cc, fcn-info.h, file-io.cc, ft-text-renderer.cc, gl2ps-print.cc, graphics.cc, graphics.in.h, help.cc, hex2num.cc, input.cc, latex-text-renderer.cc, load-path.cc, load-save.cc, load-save.h, ls-hdf5.cc, ls-mat-ascii.cc, ls-mat5.cc, ls-oct-text.cc, mex.cc, mexproto.h, mxarray.h, oct-map.cc, oct-stream.cc, oct-stream.h, pager.cc, pager.h, pr-output.cc, regexp.cc, settings.h, stack-frame.cc, stack-frame.h, strfns.cc, syminfo.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, sysdep.cc, toplev.cc, utils.cc, utils.h, variables.cc, __fltk_uigetfile__.cc, __init_fltk__.cc, audioread.cc, gzip.cc, cdef-class.cc, cdef-manager.cc, cdef-method.cc, cdef-object.cc, cdef-object.h, ov-base-diag.cc, ov-base-diag.h, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-scalar.h, ov-base-sparse.h, ov-base.cc, ov-base.h, ov-cell.cc, ov-cell.h, ov-ch-mat.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-lazy-idx.h, ov-perm.cc, ov-perm.h, ov-range.h, ov-str-mat.cc, ov-struct.cc, ov-struct.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, ovl.cc, octave.cc, bp-table.cc, jit-ir.cc, jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h, jit-util.h, lex.h, lex.ll, oct-lvalue.cc, oct-parse.yy, parse.h, profiler.h, pt-eval.cc, pt-eval.h, pt-jit.cc, pt-jit.h, pt-pr-code.cc, pt-tm-const.cc, pt-tm-const.h, Array.h, CMatrix.cc, DiagArray2.h, PermMatrix.h, Sparse.h, dMatrix.cc, fCMatrix.cc, fMatrix.cc, bsxfun-defs.cc, oct-fftw.cc, oct-fftw.h, randpoisson.cc, sparse-chol.cc, mx-inlines.cc, file-ops.cc, lo-sysdep.cc, oct-env.cc, oct-time.cc, action-container.cc, action-container.h, base-list.h, caseless-str.h, cmd-edit.cc, cmd-hist.cc, data-conv.cc, data-conv.h, f77-fcn.h, file-info.cc, file-info.h, kpse.cc, kpse.h, lo-cutils.h, lo-hash.h, lo-regexp.cc, oct-base64.cc, oct-base64.h, oct-binmap.h, oct-glob.cc, oct-shlib.cc, oct-shlib.h, oct-sort.cc, oct-sparse.h, oct-string.cc, quit.cc, unwind-prot.h, url-transfer.cc, main.in.cc, mkoctfile.in.cc, and shared-fcns.h. (grafted from aef11bb4e6d1f303ad9de5688fcb7244ef48867e)

author	John W. Eaton <jwe@octave.org>
date	Wed, 28 Apr 2021 22:57:42 -0400
parents	0a5b15007766
children	32f4357ac8d9

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: 27971 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 ////////////////////////////////////////////////////////////////////////
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20545 diff changeset	26 #if ! defined (octave_unwind_prot_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 240 diff changeset	27 #define octave_unwind_prot_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21141 diff changeset	30
17552 d07d59cc8775 move unwind-protect to liboctave John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	31 #include <cstddef>
d07d59cc8775 move unwind-protect to liboctave John W. Eaton <jwe@octave.org> parents: 16892 diff changeset	32
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	33 #include <stack>
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	34 #include <memory>
240 a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe] jwe parents: 164 diff changeset	35
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	36 #include "action-container.h"
1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	37
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	38 namespace octave
2985 aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe] jwe parents: 2847 diff changeset	39 {
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	40 class
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	41 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	42 unwind_protect : public action_container
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	43 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	44 public:
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	45
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	46 unwind_protect (void) : m_lifo () { }
2985 aa9d0c0e0458 [project @ 1997-05-16 06:54:18 by jwe] jwe parents: 2847 diff changeset	47
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	48 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	49
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	50 unwind_protect (const unwind_protect&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	51
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	52 unwind_protect& operator = (const unwind_protect&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	53
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	54 // Destructor should not raise an exception, so all actions
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	55 // registered should be exception-safe. If you're not sure, see
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	56 // unwind_protect_safe.
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	57
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	58 ~unwind_protect (void) { run (); }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	59
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	60 operator bool (void) const { return ! empty (); }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	61
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	62 void run_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	63 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	64 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	65 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	66 // No leak on exception!
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	67 std::unique_ptr<elem> ptr (m_lifo.top ());
8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	68 m_lifo.pop ();
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	69 ptr->run ();
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	70 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	71 }
12122 f4689107dd8c Explicitly disallow copying in some classes. Pascal Dupuis <Pascal.Dupuis@uclouvain.be> parents: 11586 diff changeset	72
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	73 void discard_first (void)
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	74 {
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	75 if (! empty ())
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	76 {
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	77 elem *ptr = m_lifo.top ();
8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	78 m_lifo.pop ();
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	79 delete ptr;
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	80 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	81 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	82
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	83 std::size_t size (void) const { return m_lifo.size (); }
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	84
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	85 protected:
9376 d58086453171 refactor unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 8920 diff changeset	86
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	87 virtual void add_action (elem *new_elem)
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	88 {
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	89 m_lifo.push (new_elem);
25653 b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	90 }
b3d357990b52 better use of templates for action_container and derived classes John W. Eaton <jwe@octave.org> parents: 25147 diff changeset	91
27177 8498dccc15c7 minor style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	92 std::stack<elem *> m_lifo;
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	93 };
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	94
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	95 // Like unwind_protect, but this one will guard against the possibility
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	96 // of seeing an exception (or interrupt) in the cleanup actions.
b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	97 // Not that we can do much about it, but at least we won't crash.
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	98
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	99 class
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	100 OCTAVE_API
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	101 unwind_protect_safe : public unwind_protect
15396 1054ab58cd58 abstract unwind_protect John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	102 {
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	103 private:
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	104
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	105 void warn_unhandled_exception (void) const;
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9394 diff changeset	106
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	107 public:
9396 17af7cce7d1b yet more unwind_protect improvements Jaroslav Hajek <highegg@gmail.com> parents: 9394 diff changeset	108
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	109 unwind_protect_safe (void) : unwind_protect () { }
9394 b3ab22ee8544 further improve unwind_protect Jaroslav Hajek <highegg@gmail.com> parents: 9384 diff changeset	110
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	111 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	112
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	113 unwind_protect_safe (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	114
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	115 unwind_protect_safe& operator = (const unwind_protect_safe&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	116
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	117 ~unwind_protect_safe (void)
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	118 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	119 while (! empty ())
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	120 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	121 try
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	122 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	123 run_first ();
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	124 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	125 catch (...) // Yes, the black hole. Remember we're in a destructor.
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	126 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	127 warn_unhandled_exception ();
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	128 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	129 }
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	130 }
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	131 };
27372 2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	132
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	133 // In most cases, the following are preferred for efficiency. Some
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	134 // cases may require the flexibility of the general unwind_protect
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	135 // mechanism defined above.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	136
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	137 // Perform action at end of the current scope when unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	138 // object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	139 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	140 // For example:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	141 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	142 // void fcn (int val) { ... }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	143 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	144 // ...
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	145 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	146 // {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	147 // int val = 42;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	148 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	149 // // template parameters, std::bind and std::function provide
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	150 // // flexibility in calling forms:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	151 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	152 // unwind_action act1 (fcn, val);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	153 // unwind_action act2 ([val] (void) { fcn (val); });
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	154 // }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	155 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	156 // NOTE: Don't forget to provide a name for the unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	157 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	158 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	159 // unwind_action /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	160 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	161 // then the destructor for the temporary anonymous object will be
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	162 // called immediately after the object is constructed instead of at
27971 ec769a7ab9fb fix more spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	163 // the end of the current scope.
27372 2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	164
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	165 class unwind_action
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	166 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	167 public:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	168
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	169 template <typename F, typename... Args>
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	170 unwind_action (F&& fcn, Args&&... args)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	171 : m_fcn (std::bind (fcn, args...))
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	172 { }
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 // No copying!
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	175
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	176 unwind_action (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	177
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	178 unwind_action& operator = (const unwind_action&) = delete;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	179
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	180 ~unwind_action (void) { m_fcn (); }
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	181
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	182 private:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	183
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	184 std::function<void (void)> m_fcn;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	185 };
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 // 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	188 // unwind_protect_var object destructor is called.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	189 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	190 // For example:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	191 //
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 // int x = 42;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	194 // 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	195 // x = 13; // Set temporary value.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	196 // }
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 // Temporary value may be set at construction:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	199 //
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 // int x = ...;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	202 // 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	203 // // temporary value is 13.
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	204 // }
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 // 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	207 // variable. If you write
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	208 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	209 // unwind_protect_var<type> /* NO NAME! */ (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	210 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	211 // 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	212 // called immediately after the object is constructed instead of at
27971 ec769a7ab9fb fix more spelling errors (bug #57613) John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	213 // the end of the current scope.
27372 2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	214 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	215 // 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	216 // 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	217 // constructor expression:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	218 //
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	219 // unwind_protect_var upv (...);
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	220
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	221 template <typename T>
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	222 class unwind_protect_var
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	223 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	224 public:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	225
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	226 // 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	227 // 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	228
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	229 explicit unwind_protect_var (T& ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	230 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	231 { }
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 // 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	234 // 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	235 // 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	236
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	237 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	238 : m_ref (ref), m_val (ref)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	239 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	240 m_ref = new_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	241 }
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 // No copying!
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	244
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	245 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	246
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	247 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	248
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	249 ~unwind_protect_var (void)
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	250 {
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	251 m_ref = m_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	252 }
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 private:
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	255
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	256 T& m_ref;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	257 T m_val;
2f8428b61bd6 new single-action unwind-protect classes John W. Eaton <jwe@octave.org> parents: 27177 diff changeset	258 };
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	259 }
f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21307 diff changeset	260
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	261 #endif

Mercurial > octave

annotate liboctave/util/unwind-prot.h @ 29654:d13d090cb03a stable