annotate src/ov-file.h @ 5210:996a08a3eb06 ss-2-9-0

[project @ 2005-03-15 20:46:03 by jwe]
author jwe
date Tue, 15 Mar 2005 20:46:03 +0000
parents e35b034d3523
children 4c8a2e4e0717
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
1 /*
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
2
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
4
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
6
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
10 later version.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
11
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
15 for more details.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
16
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
20
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
21 */
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
22
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
23 #if !defined (octave_file_h)
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
24 #define octave_file_h 1
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
25
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
26 #include <cstdlib>
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
27
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3340
diff changeset
28 #include <iostream>
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
29 #include <string>
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
30
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
31 #include "oct-alloc.h"
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
32 #include "oct-stream.h"
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
33 #include "ov-base.h"
4376
bfb14347a9fa [project @ 2003-04-17 14:33:12 by jwe]
jwe
parents: 4254
diff changeset
34 #include "ov-scalar.h"
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
35 #include "ov-typeinfo.h"
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
36
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
37 class tree_walker;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
38 class octave_stream;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
39 class octave_value;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
40 class octave_value_list;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
41
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
42 // Lists.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
43
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
44 class
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
45 octave_file : public octave_base_value
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
46 {
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
47 public:
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
48
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
49 octave_file (void)
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
50 : octave_base_value (), stream (), number (-1) { }
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
51
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
52 octave_file (const octave_stream& s, int n)
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
53 : octave_base_value (), stream (s), number (n) { }
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
54
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
55 octave_file (const octave_file& f)
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
56 : octave_base_value (), stream (f.stream), number (f.number) { }
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
57
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
58 ~octave_file (void) { }
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
59
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3523
diff changeset
60 octave_value *clone (void) const { return new octave_file (*this); }
4376
bfb14347a9fa [project @ 2003-04-17 14:33:12 by jwe]
jwe
parents: 4254
diff changeset
61
bfb14347a9fa [project @ 2003-04-17 14:33:12 by jwe]
jwe
parents: 4254
diff changeset
62 // For compatibility, a file object should appear as if it is a
bfb14347a9fa [project @ 2003-04-17 14:33:12 by jwe]
jwe
parents: 4254
diff changeset
63 // scalar object, in contexts where that is needed.
bfb14347a9fa [project @ 2003-04-17 14:33:12 by jwe]
jwe
parents: 4254
diff changeset
64 octave_value *empty_clone (void) const { return new octave_scalar (); }
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
65
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
66 type_conv_fcn numeric_conversion_function (void) const;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
67
4254
df5f2e433a11 [project @ 2002-12-31 19:43:07 by jwe]
jwe
parents: 4192
diff changeset
68 double double_value (bool) const { return number; }
2916
4e7bea116f24 [project @ 1997-04-30 20:56:31 by jwe]
jwe
parents: 2901
diff changeset
69
4254
df5f2e433a11 [project @ 2002-12-31 19:43:07 by jwe]
jwe
parents: 4192
diff changeset
70 double scalar_value (bool) const { return number; }
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
71
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
72 octave_stream stream_value (void) const { return stream; }
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
73
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
74 int stream_number (void) const { return number; }
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
75
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
76 bool is_defined (void) const { return true; }
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
77
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
78 bool is_stream (void) const { return true; }
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
79
4608
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
80 // Pretend we are a real scalar for better compatibility, maybe.
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
81
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
82 bool is_real_scalar (void) const { return true; }
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
83
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
84 bool is_real_type (void) const { return true; }
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
85
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
86 dim_vector dims (void) const { static dim_vector dv (1, 1); return dv; }
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
87
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
88 octave_value all (int = 0) const { return (number != 0.0); }
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
89
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
90 octave_value any (int = 0) const { return (number != 0.0); }
22ca4cc02525 [project @ 2003-11-14 03:55:04 by jwe]
jwe
parents: 4376
diff changeset
91
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
92 void print (std::ostream& os, bool pr_as_read_syntax = false) const;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
93
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
94 void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
95
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
96 bool print_name_tag (std::ostream& os, const std::string& name) const;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
97
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
98 private:
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
99
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
100 // The stream object.
3340
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe]
jwe
parents: 3219
diff changeset
101 octave_stream stream;
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
102
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
103 // The number of the beast.
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
104 int number;
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
105
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4608
diff changeset
106 DECLARE_OCTAVE_ALLOCATOR
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
107
4612
d44675070f1a [project @ 2003-11-14 19:49:56 by jwe]
jwe
parents: 4608
diff changeset
108 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
2901
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
109 };
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
110
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
111 #endif
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
112
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
113 /*
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
114 ;;; Local Variables: ***
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
115 ;;; mode: C++ ***
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
116 ;;; End: ***
e6d25bc478dd [project @ 1997-04-30 03:41:26 by jwe]
jwe
parents:
diff changeset
117 */