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

annotate libinterp/octave-value/ov-oncleanup.cc @ 19897:09ed6f7538dd

avoid needing to include hdf5 in public header files (bug #44370, #43180) * oct-hdf5-id.cc, oct-hdf5-id.h: New files. * libinterp/corefcn/module.mk: Update. * libgui/src/module.mk (src_libgui_src_la_CPPFLAGS): Remove $(HDF5_CPPFLAGS) from the list. * load-save.h (enum load_save_format_type): Always include LS_HDF5 in the list of values. * ls-hdf5.cc (read_hdf5_data, save_hdf5_data): Call check_hdf5_id_type. * oct-hdf5.h: Also #define HDF5_SAVE_TYPE. * ov.h, ov-base.h: Include oct-hdf5-id.h instead of oct-hdf5.h. Always declare load_hdf5 and save_hdf5 functions. * ov-base-int.cc, ov-base-int.h, ov-base.cc, ov-bool-mat.cc, ov-bool-mat.h, ov-bool-sparse.cc, ov-bool-sparse.h, ov-bool.cc, ov-bool.h, ov-cell.cc, ov-cell.h, ov-class.cc, ov-class.h, ov-complex.cc, ov-complex.h, ov-cx-mat.cc, ov-cx-mat.h, ov-cx-sparse.cc, ov-cx-sparse.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn-inline.cc, ov-fcn-inline.h, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h, ov-flt-cx-mat.cc, ov-flt-cx-mat.h, ov-flt-re-mat.cc, ov-flt-re-mat.h, ov-int16.cc, ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-lazy-idx.h, ov-oncleanup.cc, ov-oncleanup.h, ov-range.cc ov-range.h, ov-re-mat.cc, ov-re-mat.h, ov-re-sparse.cc, ov-re-sparse.h, ov-scalar.cc, ov-scalar.h, ov-str-mat.cc, ov-str-mat.h, ov-struct.cc, ov-struct.h, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc: Move #ifdef HAVE_HDF5 inside load_hdf5 and save_hdf5 functions. Always declare and define load_hdf5 and save_hdf5 functions.

author	John W. Eaton <jwe@octave.org> and Mike Miller <mtmiller@ieee.org>
date	Thu, 26 Feb 2015 10:49:20 -0500
parents	4197fc428c7d
children	075a5e2e1ba5

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
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19449 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
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	23 #ifdef HAVE_CONFIG_H
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	24 #include <config.h>
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"
14015 77adde2e79ac fix include file name John W. Eaton <jwe@octave.org> parents: 14013 diff changeset	28 #include "ov-oncleanup.h"
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	29 #include "ov-fcn.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	30 #include "ov-usr-fcn.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	31 #include "pt-misc.h"
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	32 #include "toplev.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);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	43 if (fptr)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	44 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	45 octave_user_function *uptr
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	46 = dynamic_cast<octave_user_function *> (fptr);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	47
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	48 if (uptr != 0)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	49 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	50 tree_parameter_list *pl = uptr->parameter_list ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	51
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	52 if (pl != 0 && pl->length () > 0)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	53 warning ("onCleanup: cleanup action takes parameters");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	54 }
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 else
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	57 error ("onCleanup: no default dispatch for function handle");
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 else
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	60 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	61 fcn = octave_value ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	62 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	63 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	64 }
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 octave_oncleanup::~octave_oncleanup (void)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	67 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	68 if (fcn.is_undefined ())
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	69 return;
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 unwind_protect frame;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	72
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	73 // Clear interrupts.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	74 frame.protect_var (octave_interrupt_state);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	75 octave_interrupt_state = 0;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	76
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	77 // Disallow quit().
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	78 frame.protect_var (quit_allowed);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	79 quit_allowed = false;
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 // Clear errors.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	82 frame.protect_var (error_state);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	83 error_state = 0;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	84
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	85 try
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	86 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	87 // Run the actual code.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	88 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	89 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	90 catch (octave_interrupt_exception)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	91 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	92 // Swallow the interrupt.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	93 warning ("onCleanup: interrupt occured in cleanup action");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	94 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	95 catch (...) // Yes, the black hole. We're in a d-tor.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	96 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	97 // This shouldn't happen, in theory.
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	98 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	99 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	100
19449 972abb60c30f emit stack trace immediately at point of error John W. Eaton <jwe@octave.org> parents: 18537 diff changeset	101 // FIXME: can this happen now?
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	102 if (error_state)
19449 972abb60c30f emit stack trace immediately at point of error John W. Eaton <jwe@octave.org> parents: 18537 diff changeset	103 frame.discard_first ();
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	104 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	105
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	106 octave_scalar_map
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	107 octave_oncleanup::scalar_map_value (void) const
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 octave_scalar_map retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	110 retval.setfield ("task", fcn);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	111 return retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	112 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	113
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	114 static void
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	115 warn_save_load (void)
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 warning ("onCleanup: load and save not supported");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	118 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	119
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	120 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	121 octave_oncleanup::save_ascii (std::ostream& /* os */)
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 warn_save_load ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	124 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	125 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	126
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	127 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	128 octave_oncleanup::load_ascii (std::istream& /* is */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	129 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	130 warn_save_load ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	131 return true;
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
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	134 bool
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	135 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	136 bool& /* save_as_floats */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	137 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	138 warn_save_load ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	139 return true;
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
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	142 bool
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	143 octave_oncleanup::load_binary (std::istream& /* is /, bool / swap */,
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	144 oct_mach_info::float_format /* fmt */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	145 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	146 warn_save_load ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	147 return true;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	148 }
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 bool
19897 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: 19731 diff changeset	151 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: 19731 diff changeset	152 const char * /* name */,
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	153 bool /* save_as_floats */)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	154 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	155 warn_save_load ();
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 bool
19897 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: 19731 diff changeset	160 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: 19731 diff changeset	161 const char * /* name */)
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	162 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	163 warn_save_load ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	164 return true;
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
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	167 void
18416 bcd71a2531d3 Support disp/display overloading in classdef Michael Goffioul <michael.goffioul@gmail.com> parents: 17787 diff changeset	168 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	169 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	170 print_raw (os, pr_as_read_syntax);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	171 newline (os);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	172 }
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 void
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	175 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	176 {
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	177 os << "onCleanup (";
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	178 if (fcn.is_defined ())
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	179 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	180 os << ")";
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	181 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	182
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	183 DEFUN (onCleanup, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	184 "-- texinfo --\n\
18533 ea0d4dea1a17 doc: Update documentation for functions in octave-value dir. Rik <rik@octave.org> parents: 17787 diff changeset	185 @deftypefn {Built-in Function} {@var{obj} =} onCleanup (@var{function})\n\
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	186 Create a special object that executes a given function upon destruction.\n\
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	187 If the object is copied to multiple variables (or cell or struct array\n\
18533 ea0d4dea1a17 doc: Update documentation for functions in octave-value dir. Rik <rik@octave.org> parents: 17787 diff changeset	188 elements) or returned from a function, @var{function} will be executed after\n\
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	189 clearing the last copy of the object. Note that if multiple local onCleanup\n\
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	190 variables are created, the order in which they are called is unspecified.\n\
15684 ddc651eecf7a Fix Info index for language statements (bug #37787) Rik <rik@octave.org> parents: 14138 diff changeset	191 For similar functionality @xref{The unwind_protect Statement}.\n\
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	192 @end deftypefn")
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 octave_value retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	195
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	196 if (args.length () == 1)
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	197 retval = octave_value (new octave_oncleanup (args(0)));
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	198 else
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	199 print_usage ();
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	200
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	201 return retval;
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	202 }
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	203
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	204 /*
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	205 %!test
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	206 %! old_wstate = warning ("query");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	207 %! unwind_protect
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	208 %! trigger = onCleanup (@() warning ("on", "__MY_WARNING__"));
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	209 %! warning ("off", "__MY_WARNING__");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	210 %! 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	211 %! clear trigger;
14013 1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	212 %! assert ((warning ("query", "__MY_WARNING__")).state, "on");
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	213 %! unwind_protect_cleanup
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	214 %! warning (old_wstate);
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	215 %! end_unwind_protect
1734ebe27134 move onCleanup function and class to liboctinterp John W. Eaton <jwe@octave.org> parents: diff changeset	216 */

Mercurial > octave-nkf

annotate libinterp/octave-value/ov-oncleanup.cc @ 19897:09ed6f7538dd