annotate src/oct-stdstrm.h @ 5540:cda6a105ae9a before-ov-branch

[project @ 2005-11-17 05:47:13 by jwe]
author jwe
date Thu, 17 Nov 2005 05:47:13 +0000
parents f07a9653b844
children ace8d8d26933
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
1 /*
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2800
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
4
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
6
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
10 later version.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
11
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
15 for more details.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
16
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5015
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5015
diff changeset
20 02110-1301, USA.
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
21
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
22 */
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
23
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
24 #if !defined (octave_octave_stdiostream_h)
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
25 #define octave_octave_stdiostream_h 1
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
26
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
27 #include "oct-stream.h"
3630
8fbe6931e709 [project @ 2000-03-23 07:42:55 by jwe]
jwe
parents: 3611
diff changeset
28 #include "c-file-ptr-stream.h"
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
29
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
30 template <typename BUF_T, typename STREAM_T, typename FILE_T>
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
31 class
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
32 octave_tstdiostream : public octave_base_stream
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
33 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
34 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
35
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
36 octave_tstdiostream (const std::string& n, FILE_T f = 0,
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
37 std::ios::openmode m = std::ios::in|std::ios::out,
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
38 oct_mach_info::float_format ff
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
39 = oct_mach_info::native_float_format (),
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
40 typename BUF_T::close_fcn cf = BUF_T::fclose)
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
41 : octave_base_stream (m, ff), nm (n), md (m),
5370
f07a9653b844 [project @ 2005-05-24 02:25:57 by jwe]
jwe
parents: 5325
diff changeset
42 s (f ? new STREAM_T (f, cf) : 0)
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
43 { }
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
44
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
45 static octave_stream
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
46 create (const std::string& n, FILE_T f = 0,
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4574
diff changeset
47 std::ios::openmode m = std::ios::in|std::ios::out,
5015
6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe]
jwe
parents: 4797
diff changeset
48 oct_mach_info::float_format ff
6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe]
jwe
parents: 4797
diff changeset
49 = oct_mach_info::native_float_format (),
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
50 typename BUF_T::close_fcn cf = BUF_T::fclose)
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
51 {
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
52 return octave_stream (new octave_tstdiostream (n, f, m, ff, cf));
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
53 }
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
54
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
55 // Position a stream at OFFSET relative to ORIGIN.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
56
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
57 int seek (long offset, int origin)
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
58 { return s ? s->seek (offset, origin) : -1; }
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
59
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
60 // Return current stream position.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
61
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
62 long tell (void) { return s ? s->tell () : -1; }
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
63
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
64 // Return non-zero if EOF has been reached on this stream.
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
65
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
66 bool eof (void) const { return s ? s->eof () : true; }
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
67
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
68 // The name of the file.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
69
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3340
diff changeset
70 std::string name (void) const { return nm; }
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
71
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
72 std::istream *input_stream (void) { return (md & std::ios::in) ? s : 0; }
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
73
4361
34014c0fb2ce [project @ 2003-03-02 03:12:08 by jwe]
jwe
parents: 4327
diff changeset
74 std::ostream *output_stream (void) { return (md & std::ios::out) ? s : 0; }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
75
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
76 // XXX FIXME XXX -- should not have to cast away const here.
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
77 BUF_T *rdbuf (void) const
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
78 { return s ? (const_cast<STREAM_T *> (s))->rdbuf () : 0; }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
79
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
80 bool bad (void) const { return s ? s->bad () : true; }
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
81
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
82 void clear (void) { if (s) s->clear (); }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
83
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
84 void do_close (void) { if (s) s->close (); }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
85
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
86 protected:
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
87
4327
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
88 std::string nm;
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
89
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
90 std::ios::openmode md;
c29c382a5b4b [project @ 2003-02-16 03:24:26 by jwe]
jwe
parents: 4326
diff changeset
91
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
92 STREAM_T *s;
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
93
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
94 ~octave_tstdiostream (void) { delete s; }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
95
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
96 private:
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
97
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
98 // No copying!
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
99
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
100 octave_tstdiostream (const octave_tstdiostream&);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
101
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
102 octave_tstdiostream& operator = (const octave_tstdiostream&);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
103 };
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
104
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
105 typedef octave_tstdiostream<c_file_ptr_buf, io_c_file_ptr_stream, FILE *> octave_stdiostream;
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
106
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
107 #ifdef HAVE_ZLIB
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
108
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
109 typedef octave_tstdiostream<c_zfile_ptr_buf, io_c_zfile_ptr_stream, gzFile> octave_zstdiostream;
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
110
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
111 #endif
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 3951
diff changeset
112
2081
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
113 #endif
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
114
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
115 /*
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
116 ;;; Local Variables: ***
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
117 ;;; mode: C++ ***
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
118 ;;; End: ***
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe]
jwe
parents:
diff changeset
119 */