octave: libinterp/octave-value/ov-class.h annotate

annotate libinterp/octave-value/ov-class.h @ 23587:0c468af9dc00

maint: Deprecate is_object and replace with isobject. * ov.h (is_object): Use OCTAVE_DEPRECATED macro around function. * ov.h (isobject): New function. * bsxfun.cc, cellfun.cc, data.cc, ls-mat5.cc, oct-stream.cc, symtab.h, variables.cc, ov-base.h, ov-class.cc, ov-class.h, ov-classdef.h, ov-oncleanup.h, ov-struct.cc, ov.cc, ov.h, op-class.cc, pt-arg-list.cc, pt-eval.cc, pt-tm-const.cc: Replace instances of is_object with isobject.

author	Rik <rik@octave.org>
date	Tue, 13 Jun 2017 11:25:31 -0700
parents	7ed6b258db91
children	194eb4bd202b

rev	line source
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	1 /*
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 2007-2017 John W. Eaton
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10313 diff changeset	4 Copyright (C) 2009 VZLU Prague
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	5
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	7
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 under the terms of the GNU General Public License as published by
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	10 the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	11 (at your option) any later version.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	12
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	16 GNU General Public License for more details.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	17
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	18 You should have received a copy of the GNU General Public License
7444 1e1e2608da7b [project @ 2008-02-04 07:40:55 by jwe] jwe parents: 7338 diff changeset	19 along with Octave; see the file COPYING. If not, see
1e1e2608da7b [project @ 2008-02-04 07:40:55 by jwe] jwe parents: 7338 diff changeset	20 <http://www.gnu.org/licenses/>.
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	21
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	22 */
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	23
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 20232 diff changeset	24 #if ! defined (octave_ov_class_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17787 diff changeset	25 #define octave_ov_class_h 1
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	26
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20990 diff changeset	27 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 20990 diff changeset	28
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	29 #include <cstdlib>
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	30
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 8920 diff changeset	31 #include <iosfwd>
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	32 #include <string>
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	33
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	34 #include "mx-base.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	35 #include "str-vec.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	36
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	37 #include "error.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	38 #include "oct-map.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	39 #include "ov-base.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	40 #include "ov-typeinfo.h"
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	41
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	42 class octave_value_list;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	43
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	44 // Data structures.
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	45
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	46 class
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	47 octave_class : public octave_base_value
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	48 {
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	49 public:
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	50
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	51 octave_class (void)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	52 : octave_base_value (), map (), c_name (),
12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	53 parent_list (), obsolete_copies (0)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	54 { }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	55
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13241 diff changeset	56 octave_class (const octave_map& m, const std::string& id,
13874 c1b754d93572 copy parent class info when performing operations on class objects John W. Eaton <jwe@octave.org> parents: 13694 diff changeset	57 const std::list<std::string>& plist)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	58 : octave_base_value (), map (m), c_name (id),
13294 7dce7e110511 make concatenation of class objects work John W. Eaton <jwe@octave.org> parents: 13241 diff changeset	59 parent_list (plist), obsolete_copies (0)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	60 { }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	61
13874 c1b754d93572 copy parent class info when performing operations on class objects John W. Eaton <jwe@octave.org> parents: 13694 diff changeset	62 octave_class (const octave_map& m, const std::string& id,
c1b754d93572 copy parent class info when performing operations on class objects John W. Eaton <jwe@octave.org> parents: 13694 diff changeset	63 const octave_value_list& parents);
c1b754d93572 copy parent class info when performing operations on class objects John W. Eaton <jwe@octave.org> parents: 13694 diff changeset	64
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	65 octave_class (const octave_class& s)
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	66 : octave_base_value (s), map (s.map), c_name (s.c_name),
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	67 parent_list (s.parent_list), obsolete_copies (0) { }
9010 f914834836e7 Partial implementation of derived classes using the old form with "@" files. rtshort@smoketree.phaselocked.com parents: 8950 diff changeset	68
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	69 ~octave_class (void) = default;
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	70
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	71 octave_base_value * clone (void) const { return new octave_class (*this); }
8785 70f5a0375afd oct-map.h: fix think-o in previous change John W. Eaton <jwe@octave.org> parents: 8212 diff changeset	72
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	73 octave_base_value * unique_clone (void);
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9521 diff changeset	74
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	75 octave_base_value * empty_clone (void) const
8785 70f5a0375afd oct-map.h: fix think-o in previous change John W. Eaton <jwe@octave.org> parents: 8212 diff changeset	76 {
13874 c1b754d93572 copy parent class info when performing operations on class objects John W. Eaton <jwe@octave.org> parents: 13694 diff changeset	77 return new octave_class (octave_map (map.keys ()), c_name, parent_list);
8785 70f5a0375afd oct-map.h: fix think-o in previous change John W. Eaton <jwe@octave.org> parents: 8212 diff changeset	78 }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	79
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	80 Cell dotref (const octave_value_list& idx);
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	81
9329 67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9240 diff changeset	82 Matrix size (void);
67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9240 diff changeset	83
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	84 octave_idx_type numel (const octave_value_list&);
9329 67fc970dad7d improve indexed assignment using indexed numel Jaroslav Hajek <highegg@gmail.com> parents: 9240 diff changeset	85
7651 443a8f5a50fd require both subsref variants to be defined in octave_value subclasses John W. Eaton <jwe@octave.org> parents: 7444 diff changeset	86 octave_value subsref (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	87 const std::list<octave_value_list>& idx)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	88 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	89 octave_value_list tmp = subsref (type, idx, 1);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	90 return tmp.length () > 0 ? tmp(0) : octave_value ();
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	91 }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	92
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	93 octave_value_list subsref (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	94 const std::list<octave_value_list>& idx,
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	95 int nargout);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	96
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	97 static octave_value numeric_conv (const Cell& val,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	98 const std::string& type);
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	99
9147 5579998f8acf Update to OOP facilities. rtshort@bristlecone.phaselocked.com parents: 9010 diff changeset	100 void assign(const std::string& k, const octave_value& rhs)
5579998f8acf Update to OOP facilities. rtshort@bristlecone.phaselocked.com parents: 9010 diff changeset	101 { map.assign (k, rhs); };
5579998f8acf Update to OOP facilities. rtshort@bristlecone.phaselocked.com parents: 9010 diff changeset	102
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	103 octave_value subsasgn (const std::string& type,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	104 const std::list<octave_value_list>& idx,
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	105 const octave_value& rhs);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	106
12171 d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	107 octave_value undef_subsasgn (const std::string& type,
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	108 const std::list<octave_value_list>& idx,
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	109 const octave_value& rhs);
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	110
18130 e473c4853afc enable non-integer ranges as indices by default and deprecate preference John W. Eaton <jwe@octave.org> parents: 17822 diff changeset	111 idx_vector index_vector (bool require_integers = false) const;
8154 265a821f6555 Add subsindex and ismethod functions David Bateman <dbateman@free.fr> parents: 7651 diff changeset	112
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	113 dim_vector dims (void) const { return map.dims (); }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	114
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	115 size_t byte_size (void) const;
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	116
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	117 // This is the number of elements in each field. The total number
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	118 // of elements is numel () * nfields ().
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	119 octave_idx_type numel (void) const
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	120 {
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	121 dim_vector dv = dims ();
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	122 return dv.numel ();
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	123 }
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	124
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	125 octave_idx_type nfields (void) const { return map.nfields (); }
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	126
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	127 size_t nparents (void) const { return parent_list.size (); }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	128
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	129 octave_value reshape (const dim_vector& new_dims) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	130 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	131 octave_class retval = octave_class (*this);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	132 retval.map = retval.map_value ().reshape (new_dims);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	133 return octave_value (new octave_class (retval));
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	134 }
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	135
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	136 octave_value resize (const dim_vector& dv, bool = false) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	137 {
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	138 octave_class retval = octave_class (*this);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	139 retval.map.resize (dv);
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	140 return octave_value (new octave_class (retval));
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	141 }
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	142
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	143 bool is_defined (void) const { return true; }
8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	144
23584 7ed6b258db91 maint: Deprecate is_map and replace with isstruct. Rik <rik@octave.org> parents: 23502 diff changeset	145 bool isstruct (void) const { return false; }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	146
23587 0c468af9dc00 maint: Deprecate is_object and replace with isobject. Rik <rik@octave.org> parents: 23584 diff changeset	147 bool isobject (void) const { return true; }
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	148
21725 78e0b187904b Call @class/logical method for objects in conditional expressions (bug #43097) Mike Miller <mtmiller@octave.org> parents: 21244 diff changeset	149 bool is_true (void) const;
78e0b187904b Call @class/logical method for objects in conditional expressions (bug #43097) Mike Miller <mtmiller@octave.org> parents: 21244 diff changeset	150
10742 604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	151 octave_map map_value (void) const { return map; }
604e13a89c7f initial code for structs rewrite Jaroslav Hajek <highegg@gmail.com> parents: 10521 diff changeset	152
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	153 string_vector map_keys (void) const;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	154
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	155 std::list<std::string> parent_class_name_list (void) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	156 { return parent_list; }
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	157
9010 f914834836e7 Partial implementation of derived classes using the old form with "@" files. rtshort@smoketree.phaselocked.com parents: 8950 diff changeset	158 string_vector parent_class_names (void) const
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	159 { return string_vector (parent_list); }
9010 f914834836e7 Partial implementation of derived classes using the old form with "@" files. rtshort@smoketree.phaselocked.com parents: 8950 diff changeset	160
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	161 octave_base_value * find_parent_class (const std::string&);
9010 f914834836e7 Partial implementation of derived classes using the old form with "@" files. rtshort@smoketree.phaselocked.com parents: 8950 diff changeset	162
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	163 octave_base_value * unique_parent_class (const std::string&);
9767 0df32e0b2074 fix base class field assignment Jaroslav Hajek <highegg@gmail.com> parents: 9581 diff changeset	164
19103 56bc1464ec59 Implement "isa" for classdef objects. Michael Goffioul <michael.goffioul@gmail.com> parents: 18416 diff changeset	165 bool is_instance_of (const std::string&) const;
56bc1464ec59 Implement "isa" for classdef objects. Michael Goffioul <michael.goffioul@gmail.com> parents: 18416 diff changeset	166
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20791 diff changeset	167 string_vector string_vector_value (bool pad) const;
13694 441af0aa125a char: when converting cell elements containing class objects, call overloaded char function if one exists John W. Eaton <jwe@octave.org> parents: 13294 diff changeset	168
18416 bcd71a2531d3 Support disp/display overloading in classdef Michael Goffioul <michael.goffioul@gmail.com> parents: 18130 diff changeset	169 void print (std::ostream& os, bool pr_as_read_syntax = false);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	170
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	171 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	172
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	173 bool print_name_tag (std::ostream& os, const std::string& name) const;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	174
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	175 void print_with_name (std::ostream& os, const std::string& name,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	176 bool print_padding = true);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	177
9190 7a10410db2c6 [mq]: x Robert T. Short <rtshort@ieee.org> parents: 9182 diff changeset	178 bool reconstruct_exemplar (void);
7a10410db2c6 [mq]: x Robert T. Short <rtshort@ieee.org> parents: 9182 diff changeset	179
9240 f27a8c07f0b2 clear -classes and support. Robert T. Short <octave@phaselockedsystems.com> parents: 9190 diff changeset	180 static void clear_exemplar_map (void);
f27a8c07f0b2 clear -classes and support. Robert T. Short <octave@phaselockedsystems.com> parents: 9190 diff changeset	181
9182 23af5910e5f5 make load work for derived classses Robert T. Short <octave@phaselockedsystems.com> parents: 9151 diff changeset	182 bool reconstruct_parents (void);
23af5910e5f5 make load work for derived classses Robert T. Short <octave@phaselockedsystems.com> parents: 9151 diff changeset	183
8212 ebf6f6a0f9a7 Allow saving/loading of classes. Add saveobj and loadobj methods David Bateman <dbateman@free.fr> parents: 8154 diff changeset	184 bool save_ascii (std::ostream& os);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	185
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	186 bool load_ascii (std::istream& is);
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	187
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	188 bool save_binary (std::ostream& os, bool& save_as_floats);
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	189
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11584 diff changeset	190 bool load_binary (std::istream& is, bool swap,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21725 diff changeset	191 octave::mach_info::float_format fmt);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	192
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	193 bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	194
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	195 bool load_hdf5 (octave_hdf5_id loc_id, const char *name);
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	196
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	197 mxArray * as_mxArray (void) const;
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	198
9529 8e5009334661 partially revert e79470be3ecb Jaroslav Hajek <highegg@gmail.com> parents: 9522 diff changeset	199 private:
10768 8a868004a437 use octave_map for octave_class Jaroslav Hajek <highegg@gmail.com> parents: 10742 diff changeset	200 octave_map map;
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	201
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	202 public:
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	203 int type_id (void) const { return t_id; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	204 std::string type_name (void) const { return t_name; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	205 std::string class_name (void) const { return c_name; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	206
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	207 static int static_type_id (void) { return t_id; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	208 static std::string static_type_name (void) { return t_name; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	209 static std::string static_class_name (void) { return "<unknown>"; }
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	210 static void register_type (void);
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	211
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	212 private:
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	213 static int t_id;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	214
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	215 static const std::string t_name;
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	216 std::string c_name;
9010 f914834836e7 Partial implementation of derived classes using the old form with "@" files. rtshort@smoketree.phaselocked.com parents: 8950 diff changeset	217 std::list<std::string> parent_list;
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	218
9581 3d0d2bda3a0f fix previous change, avoid duplicate loads of methods in descendant classes Jaroslav Hajek <highegg@gmail.com> parents: 9529 diff changeset	219 bool in_class_method (void);
10926 f687bd17ce21 fix field assignment from private class methods Jaroslav Hajek <highegg@gmail.com> parents: 10768 diff changeset	220 std::string get_current_method_class (void);
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	221
12171 d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	222 octave_value subsasgn_common (const octave_value& obj,
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	223 const std::string& type,
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	224 const std::list<octave_value_list>& idx,
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	225 const octave_value& rhs);
d08901c05c1b fix bug in class assignment to undefined object with index John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	226
9522 e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9521 diff changeset	227 int obsolete_copies;
e79470be3ecb implement subsasgn this-arg optimization Jaroslav Hajek <highegg@gmail.com> parents: 9521 diff changeset	228
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	229 public:
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	230 // The list of field names and parent classes defines a class. We
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	231 // keep track of each class that has been created so that we know
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	232 class exemplar_info
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	233 {
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	234 public:
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	235
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	236 exemplar_info (void) : field_names (), parent_class_names () { }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	237
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	238 exemplar_info (const octave_value& obj);
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	239
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	240 exemplar_info (const exemplar_info& x)
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	241 : field_names (x.field_names),
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	242 parent_class_names (x.parent_class_names) { }
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	243
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	244 exemplar_info& operator = (const exemplar_info& x)
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	245 {
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	246 if (&x != this)
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	247 {
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	248 field_names = x.field_names;
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	249 parent_class_names = x.parent_class_names;
f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	250 }
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	251 return *this;
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	252 }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	253
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 19863 diff changeset	254 octave_idx_type nfields (void) const { return field_names.numel (); }
9151 d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	255
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	256 size_t nparents (void) const { return parent_class_names.size (); }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	257
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	258 string_vector fields (void) const { return field_names; }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	259
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	260 std::list<std::string> parents (void) const { return parent_class_names; }
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	261
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	262 bool compare (const octave_value& obj) const;
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	263
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	264 private:
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	265
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	266 string_vector field_names;
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	267 std::list<std::string> parent_class_names;
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	268 };
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	269
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	270 // A map from class names to lists of fields.
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	271 static std::map<std::string, exemplar_info> exemplar_map;
d8f9588c6ba1 object exemplars John W. Eaton <jwe@octave.org> parents: 9147 diff changeset	272
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	273 typedef std::map<std::string, exemplar_info>::iterator
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	274 exemplar_iterator;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	275 typedef std::map<std::string, exemplar_info>::const_iterator
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	276 exemplar_const_iterator;
7338 5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	277 };
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	278
5215422865e0 [project @ 2007-12-28 22:31:35 by jwe] jwe parents: diff changeset	279 #endif

Mercurial > octave

annotate libinterp/octave-value/ov-class.h @ 23587:0c468af9dc00