1 //////////////////////////////////////////////////////////////////////// 2 // 3 // Copyright (C) 2010-2021 The Octave Project Developers 4 // 5 // See the file COPYRIGHT.md in the top-level directory of this 6 // distribution or <https://octave.org/copyright/>. 7 // 8 // This file is part of Octave. 9 // 10 // Octave is free software: you can redistribute it and/or modify it 11 // under the terms of the GNU General Public License as published by 12 // the Free Software Foundation, either version 3 of the License, or 13 // (at your option) any later version. 14 // 15 // Octave is distributed in the hope that it will be useful, but 16 // WITHOUT ANY WARRANTY; without even the implied warranty of 17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 // GNU General Public License for more details. 19 // 20 // You should have received a copy of the GNU General Public License 21 // along with Octave; see the file COPYING. If not, see 22 // <https://www.gnu.org/licenses/>. 23 // 24 //////////////////////////////////////////////////////////////////////// 25 26 #if ! defined (octave_ov_oncleanup_h) 27 #define octave_ov_oncleanup_h 1 28 29 #include "octave-config.h" 30 31 #include <iosfwd> 32 33 #include "ov-base.h" 34 #include "ov-struct.h" 35 #include "ov.h" 36 37 38 class octave_oncleanup : public octave_base_value 39 { 40 public: 41 42 octave_oncleanup (void) = default; 43 44 octave_oncleanup (const octave_value& fcn); 45 clone(void)46 octave_base_value * clone (void) const 47 { 48 if (fcn.is_defined ()) 49 error ("onCleanup: internal error: cloning nonempty object"); 50 51 return empty_clone (); 52 } 53 empty_clone(void)54 octave_base_value * empty_clone (void) const 55 { 56 return new octave_oncleanup (); 57 } 58 59 ~octave_oncleanup (void); 60 is_defined(void)61 bool is_defined (void) const { return true; } 62 isobject(void)63 bool isobject (void) const { return true; } // do we want this? 64 map_value(void)65 octave_map map_value (void) const { return scalar_map_value (); } 66 67 octave_scalar_map scalar_map_value (void) const; 68 dims(void)69 dim_vector dims (void) const 70 { 71 static dim_vector dv (1, 1); 72 return dv; 73 } 74 75 bool save_ascii (std::ostream& os); 76 77 bool load_ascii (std::istream& is); 78 79 bool save_binary (std::ostream& os, bool save_as_floats); 80 81 bool load_binary (std::istream& is, bool swap, 82 octave::mach_info::float_format fmt); 83 84 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); 85 86 bool load_hdf5 (octave_hdf5_id loc_id, const char *name); 87 88 void print (std::ostream& os, bool pr_as_read_syntax = false); 89 90 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; 91 92 void call_object_destructor (void); 93 94 private: 95 96 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA 97 98 protected: 99 100 octave_value fcn; 101 }; 102 103 #endif 104