octave: libinterp/octave-value/ov-oncleanup.cc annotate

annotate libinterp/octave-value/ov-oncleanup.cc @ 22094:9203833cab7d

move new interpreter class to separate file * libinterp/corefcn/interpreter.cc, libinterp/corefcn/interpreter.h: New files. Move interpreter class and some supporting functions here from octave.h, octave.cc, toplev.h, and toplev.cc. Move main_loop into the interpreter class. Handle exiting with a separate exception object from interrupts, passing the exit status with the object. Update other files as needed to remove toplev.h or include interpreter.h instead of toplev.h. * libinterp/corefcn/module.mk: Update. * toplev.h: Deprecate.

author	John W. Eaton <jwe@octave.org>
date	Mon, 11 Jul 2016 18:05:53 -0400
parents	112b20240c87
children	63c806042c27

rev	line source
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	1 /*
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	2
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19415 diff changeset	3 Copyright (C) 2010-2015 VZLU Prague
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	4
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	5 This file is part of Octave.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	6
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	7 Octave is free software; you can redistribute it and/or modify it
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	8 under the terms of the GNU General Public License as published by the
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	9 Free Software Foundation; either version 3 of the License, or (at your
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	10 option) any later version.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	11
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	12 Octave is distributed in the hope that it will be useful, but WITHOUT
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	15 for more details.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	16
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	17 You should have received a copy of the GNU General Public License
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	18 along with Octave; see the file COPYING. If not, see
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	19 <http://www.gnu.org/licenses/>.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	20
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	21 */
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	22
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21301 diff changeset	23 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	24 # include "config.h"
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	25 #endif
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	26
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	27 #include "defun.h"
22094 9203833cab7d move new interpreter class to separate file John W. Eaton <jwe@octave.org> parents: 21966 diff changeset	28 #include "interpreter.h"
14015 77adde2e79ac fix include file name John W. Eaton <jwe@octave.org> parents: 14013 diff changeset	29 #include "ov-oncleanup.h"
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	30 #include "ov-fcn.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	31 #include "ov-usr-fcn.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	32 #include "pt-misc.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	33
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	34 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_oncleanup, "onCleanup",
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	35 "onCleanup");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	36
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	37 octave_oncleanup::octave_oncleanup (const octave_value& f)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	38 : fcn (f)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	39 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	40 if (f.is_function_handle ())
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	41 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	42 octave_function *fptr = f.function_value (true);
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	43 if (! fptr)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	44 error ("onCleanup: no default dispatch for function handle");
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	45
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	46 octave_user_function *uptr
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	47 = dynamic_cast<octave_user_function *> (fptr);
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	48
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	49 if (uptr != 0)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	50 {
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	51 tree_parameter_list *pl = uptr->parameter_list ();
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	52
20962 3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	53 if (pl != 0 && pl->length () > 0)
3aa293be0e8d maint: Invert simple conditionals in if/else/error paradigm. Rik <rik@octave.org> parents: 20939 diff changeset	54 warning ("onCleanup: cleanup action takes parameters");
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	55 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	56 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	57 else
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	58 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	59 fcn = octave_value ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	60 error ("onCleanup: argument must be a function handle");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	61 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	62 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	63
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	64 octave_oncleanup::~octave_oncleanup (void)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	65 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	66 if (fcn.is_undefined ())
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	67 return;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	68
21743 f4d7d0eb5b0c use namespace for unwind_protect class John W. Eaton <jwe@octave.org> parents: 21739 diff changeset	69 octave::unwind_protect frame;
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	70
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	71 // Clear interrupts.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	72 frame.protect_var (octave_interrupt_state);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	73 octave_interrupt_state = 0;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	74
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	75 // Disallow quit().
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	76 frame.protect_var (quit_allowed);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	77 quit_allowed = false;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	78
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	79 try
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	80 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	81 // Run the actual code.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	82 fcn.do_multi_index_op (0, octave_value_list ());
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	83 }
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20467 diff changeset	84 catch (const octave_interrupt_exception&)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	85 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	86 recover_from_exception ();
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	87
21004 f7e416862e90 doc: fix spelling of "occurred". Rafael Laboissiere <rafael@laboissiere.net> parents: 20163 diff changeset	88 warning ("onCleanup: interrupt occurred in cleanup action");
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	89 }
20535 b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20467 diff changeset	90 catch (const octave_execution_exception&)
b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20467 diff changeset	91 {
b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20467 diff changeset	92 throw;
b70cc4bd8109 begin removal of global error_state variable John W. Eaton <jwe@octave.org> parents: 20467 diff changeset	93 }
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21743 diff changeset	94 catch (...) // Yes, the black hole. We're in a d-tor.
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	95 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	96 // This shouldn't happen, in theory.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	97 error ("onCleanup: internal error: unhandled exception in cleanup action");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	98 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	99 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	100
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	101 octave_scalar_map
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	102 octave_oncleanup::scalar_map_value (void) const
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	103 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	104 octave_scalar_map retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	105 retval.setfield ("task", fcn);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	106 return retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	107 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	108
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	109 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	110 octave_oncleanup::save_ascii (std::ostream& /* os */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	111 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	112 warning ("save: unable to save onCleanup variables, skipping");
4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	113
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	114 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	115 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	116
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	117 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	118 octave_oncleanup::load_ascii (std::istream& /* is */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	119 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	120 // Silently skip object that was not saved
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	121 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	122 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	123
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	124 bool
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	125 octave_oncleanup::save_binary (std::ostream& /* os */,
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	126 bool& /* save_as_floats */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	127 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	128 warning ("save: unable to save onCleanup variables, skipping");
4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	129
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	130 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	131 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	132
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	133 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	134 octave_oncleanup::load_binary (std::istream& /* is /, bool / swap */,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	135 octave::mach_info::float_format /* fmt */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	136 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	137 // Silently skip object that was not saved
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	138 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	139 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	140
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	141 bool
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	142 octave_oncleanup::save_hdf5 (octave_hdf5_id /* loc_id */,
09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	143 const char * /* name */,
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	144 bool /* save_as_floats */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	145 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	146 warning ("save: unable to save onCleanup variables, skipping");
4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	147
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	148 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	149 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	150
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	151 bool
19863 09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	152 octave_oncleanup::load_hdf5 (octave_hdf5_id /* loc_id */,
09ed6f7538dd avoid needing to include hdf5 in public header files (bug #44370, #43180) John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	153 const char * /* name */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	154 {
20467 4bef1880098c More specific warning messages when saving onCleanup variables. Rik <rik@octave.org> parents: 20163 diff changeset	155 // Silently skip object that was not saved
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	156 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	157 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	158
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	159 void
18416 bcd71a2531d3 Support disp/display overloading in classdef Michael Goffioul <michael.goffioul@gmail.com> parents: 17787 diff changeset	160 octave_oncleanup::print (std::ostream& os, bool pr_as_read_syntax)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	161 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	162 print_raw (os, pr_as_read_syntax);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	163 newline (os);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	164 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	165
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	166 void
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	167 octave_oncleanup::print_raw (std::ostream& os, bool pr_as_read_syntax) const
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	168 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	169 os << "onCleanup (";
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	170 if (fcn.is_defined ())
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	171 fcn.print_raw (os, pr_as_read_syntax);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	172 os << ")";
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	173 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	174
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	175 DEFUN (onCleanup, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	176 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	177 @deftypefn {} {@var{obj} =} onCleanup (@var{function})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	178 Create a special object that executes a given function upon destruction.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	179
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	180 If the object is copied to multiple variables (or cell or struct array
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	181 elements) or returned from a function, @var{function} will be executed after
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	182 clearing the last copy of the object. Note that if multiple local onCleanup
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	183 variables are created, the order in which they are called is unspecified.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	184 For similar functionality @xref{The unwind_protect Statement}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	185 @end deftypefn */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	186 {
20797 492738d32c60 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	187 if (args.length () != 1)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	188 print_usage ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	189
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	190 return ovl (new octave_oncleanup (args(0)));
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	191 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	192
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	193 /*
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	194 %!test
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	195 %! old_wstate = warning ("query");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	196 %! unwind_protect
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	197 %! trigger = onCleanup (@() warning ("on", "__MY_WARNING__"));
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	198 %! warning ("off", "__MY_WARNING__");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	199 %! assert ((warning ("query", "__MY_WARNING__")).state, "off");
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	200 %! clear trigger;
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	201 %! assert ((warning ("query", "__MY_WARNING__")).state, "on");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	202 %! unwind_protect_cleanup
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	203 %! warning (old_wstate);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	204 %! end_unwind_protect
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	205 */

Mercurial > octave

annotate libinterp/octave-value/ov-oncleanup.cc @ 22094:9203833cab7d