annotate libinterp/corefcn/c-file-ptr-stream.h @ 29991:3988112c7116

move i/o stream classes inside octave namespace * c-file-ptr-stream.h, c-file-ptr-stream.cc, file-io.cc, oct-fstrm.cc, oct-fstrm.h, oct-iostrm.cc, oct-iostrm.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-stdstrm.h, oct-stream.cc, oct-strstrm.cc, oct-strstrm.h, procstream.cc, procstream.h: Move classes inside octave namespace. Change all uses. Provide deprecated typedefs to preserve old names where possible.
author John W. Eaton <jwe@octave.org>
date Tue, 17 Aug 2021 11:17:36 -0400
parents 0a5b15007766
children 8dd5da409418
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
3 // Copyright (C) 2000-2021 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
25
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 20088
diff changeset
26 #if ! defined (octave_c_file_ptr_stream_h)
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
27 #define octave_c_file_ptr_stream_h 1
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
28
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21200
diff changeset
29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 21200
diff changeset
30
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
31 #include <cstdio>
25444
37132909ac91 Supply missing iostream declarations via <istream> (bug #54091)
Daniel J Sebald <daniel.sebald@ieee.org>
parents: 25438
diff changeset
32 #include <istream>
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
33
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
34 #if defined (HAVE_ZLIB_H)
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
35 # include <zlib.h>
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
36 #endif
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
37
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
38 OCTAVE_NAMESPACE_BEGIN
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
39
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
40 class
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
41 c_file_ptr_buf : public std::streambuf
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
42 {
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
43 public:
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
44
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
45 typedef std::streambuf::int_type int_type;
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
46
3716
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe]
jwe
parents: 3652
diff changeset
47 typedef int (*close_fcn) (FILE *);
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe]
jwe
parents: 3652
diff changeset
48
23449
c763214a8260 maint: Use convention 'int *x' for naming pointers.
Rik <rik@octave.org>
parents: 23446
diff changeset
49 FILE *stdiofile (void) { return f; }
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
50
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
51 c_file_ptr_buf (FILE *f_arg, close_fcn cf_arg = file_close)
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
52 : std::streambuf (), f (f_arg), cf (cf_arg)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
53 { }
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
54
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
55 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
56
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
57 c_file_ptr_buf (const c_file_ptr_buf&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
58
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
59 c_file_ptr_buf& operator = (const c_file_ptr_buf&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
60
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
61 ~c_file_ptr_buf (void);
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
62
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
63 int_type overflow (int_type);
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
64
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
65 int_type underflow (void) { return underflow_common (false); }
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
66
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
67 int_type uflow (void) { return underflow_common (true); }
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
68
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
69 int_type pbackfail (int_type);
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
70
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
71 std::streamsize xsputn (const char*, std::streamsize);
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
72
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
73 std::streamsize xsgetn (char *, std::streamsize);
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
74
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
75 std::streampos seekoff (std::streamoff, std::ios::seekdir,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10288
diff changeset
76 std::ios::openmode = std::ios::in | std::ios::out);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
77
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
78 std::streampos seekpos (std::streampos,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10288
diff changeset
79 std::ios::openmode = std::ios::in | std::ios::out);
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
80
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
81 int sync (void);
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
82
3652
25e84fcef38a [project @ 2000-03-31 08:50:48 by jwe]
jwe
parents: 3644
diff changeset
83 int flush (void);
25e84fcef38a [project @ 2000-03-31 08:50:48 by jwe]
jwe
parents: 3644
diff changeset
84
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
85 int buf_close (void);
3652
25e84fcef38a [project @ 2000-03-31 08:50:48 by jwe]
jwe
parents: 3644
diff changeset
86
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
87 int file_number () const { return f ? fileno (f) : -1; }
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
88
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
89 int seek (off_t offset, int origin);
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
90
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
91 off_t tell (void);
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
92
4888
4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe]
jwe
parents: 4797
diff changeset
93 void clear (void) { if (f) clearerr (f); }
4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe]
jwe
parents: 4797
diff changeset
94
10411
479cc8a0a846 use gnulib namespace
John W. Eaton <jwe@octave.org>
parents: 10313
diff changeset
95 static int file_close (FILE *f);
3951
e6f67a1ed814 [project @ 2002-05-23 03:41:25 by jwe]
jwe
parents: 3944
diff changeset
96
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
97 protected:
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
98
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
99 FILE *f;
3716
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe]
jwe
parents: 3652
diff changeset
100
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe]
jwe
parents: 3652
diff changeset
101 close_fcn cf;
3775
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
102
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
103 private:
13905c3a24af [project @ 2001-02-06 01:56:59 by jwe]
jwe
parents: 3716
diff changeset
104
4310
da7226ca8b91 [project @ 2003-01-30 03:26:26 by jwe]
jwe
parents: 4192
diff changeset
105 int_type underflow_common (bool);
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
106 };
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
107
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
108 // FIXME: the following three classes could probably share some code...
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
109
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
110 template <typename STREAM_T, typename FILE_T, typename BUF_T>
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
111 class
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
112 c_file_ptr_stream : public STREAM_T
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
113 {
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
114 public:
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
115
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
116 c_file_ptr_stream (FILE_T f, typename BUF_T::close_fcn cf = BUF_T::file_close)
23795
980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23449
diff changeset
117 : STREAM_T (nullptr), buf (new BUF_T (f, cf)) { STREAM_T::init (buf); }
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
118
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
119 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
120
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
121 c_file_ptr_stream (const c_file_ptr_stream&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
122
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
123 c_file_ptr_stream& operator = (const c_file_ptr_stream&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
124
23795
980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23449
diff changeset
125 ~c_file_ptr_stream (void) { delete buf; buf = nullptr; }
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
126
23446
cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents: 23220
diff changeset
127 BUF_T * rdbuf (void) { return buf; }
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
128
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
129 void stream_close (void) { if (buf) buf->buf_close (); }
3652
25e84fcef38a [project @ 2000-03-31 08:50:48 by jwe]
jwe
parents: 3644
diff changeset
130
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
131 int seek (off_t offset, int origin)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
132 { return buf ? buf->seek (offset, origin) : -1; }
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
133
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
134 off_t tell (void) { return buf ? buf->tell () : -1; }
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
135
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
136 void clear (void) { if (buf) buf->clear (); STREAM_T::clear (); }
4888
4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe]
jwe
parents: 4797
diff changeset
137
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
138 private:
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
139
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
140 BUF_T *buf;
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
141 };
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
142
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
143 typedef c_file_ptr_stream<std::istream, FILE *, c_file_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
144 i_c_file_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
145 typedef c_file_ptr_stream<std::ostream, FILE *, c_file_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
146 o_c_file_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
147 typedef c_file_ptr_stream<std::iostream, FILE *, c_file_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
148 io_c_file_ptr_stream;
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
149
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
150
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21244
diff changeset
151 #if defined (HAVE_ZLIB)
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
152
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
153 class
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
154 c_zfile_ptr_buf : public std::streambuf
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
155 {
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
156 public:
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
157
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
158 typedef std::streambuf::int_type int_type;
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
159
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
160 typedef int (*close_fcn) (gzFile);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
161
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
162 gzFile stdiofile (void) { return f; }
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
163
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
164 c_zfile_ptr_buf (gzFile f_arg, close_fcn cf_arg = file_close)
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
165 : std::streambuf (), f (f_arg), cf (cf_arg)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
166 { }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
167
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
168 // No copying!
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
169
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
170 c_zfile_ptr_buf (const c_zfile_ptr_buf&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
171
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
172 c_zfile_ptr_buf& operator = (const c_zfile_ptr_buf&) = delete;
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
173
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
174 ~c_zfile_ptr_buf (void);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
175
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
176 int_type overflow (int_type);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
177
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
178 int_type underflow (void) { return underflow_common (false); }
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
179
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
180 int_type uflow (void) { return underflow_common (true); }
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
181
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
182 int_type pbackfail (int_type);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
183
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
184 std::streamsize xsputn (const char*, std::streamsize);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
185
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
186 std::streamsize xsgetn (char *, std::streamsize);
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
187
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
188 std::streampos seekoff (std::streamoff, std::ios::seekdir,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10288
diff changeset
189 std::ios::openmode = std::ios::in | std::ios::out);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
190
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
191 std::streampos seekpos (std::streampos,
10313
f3b65e1ae355 untabify src header files
John W. Eaton <jwe@octave.org>
parents: 10288
diff changeset
192 std::ios::openmode = std::ios::in | std::ios::out);
3644
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe]
jwe
parents: 3628
diff changeset
193
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
194 int sync (void);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
195
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
196 int flush (void);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
197
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
198 int buf_close (void);
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
199
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
200 int file_number () const { return -1; }
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
201
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
202 int seek (off_t offset, int origin)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
203 { return f ? gzseek (f, offset, origin) >= 0 : -1; }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
204
16011
8122286c69a9 initial large file support for 32-bit systems
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
205 off_t tell (void) { return f ? gztell (f) : -1; }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
206
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
207 void clear (void) { if (f) gzclearerr (f); }
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
208
10288
5e972e2deffe avoid some possible gnulib #defines
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
209 static int file_close (gzFile f) { return ::gzclose (f); }
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
210
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
211 protected:
4797
19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe]
jwe
parents: 4326
diff changeset
212
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
213 gzFile f;
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
214
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
215 close_fcn cf;
4888
4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe]
jwe
parents: 4797
diff changeset
216
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
217 private:
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
218
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
219 int_type underflow_common (bool);
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
220 };
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
221
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
222 typedef c_file_ptr_stream<std::istream, gzFile, c_zfile_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
223 i_c_zfile_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
224 typedef c_file_ptr_stream<std::ostream, gzFile, c_zfile_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
225 o_c_zfile_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
226 typedef c_file_ptr_stream<std::iostream, gzFile, c_zfile_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
227 io_c_zfile_ptr_stream;
4326
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe]
jwe
parents: 4310
diff changeset
228
5325
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe]
jwe
parents: 5307
diff changeset
229 #endif
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
230
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
231 OCTAVE_NAMESPACE_END
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
232
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
233 #if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS)
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
234
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
235 OCTAVE_DEPRECATED (7, "use 'octave::i_c_file_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
236 typedef octave::i_c_file_ptr_stream i_c_file_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
237
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
238 OCTAVE_DEPRECATED (7, "use 'octave::o_c_file_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
239 typedef octave::o_c_file_ptr_stream o_c_file_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
240
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
241 OCTAVE_DEPRECATED (7, "use 'octave::io_c_file_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
242 typedef octave::io_c_file_ptr_stream io_c_file_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
243
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
244 // FIXME: HAVE_ZLIB is not defined here because we do not (and should
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
245 // not) include config.h in this header file. We need to find a way to
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
246 // define this interface without exposing gzFile. Should this be a
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
247 // private header that can only be used if included after config.h in an
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
248 // Octave source file and not inside another header file?
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
249
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
250 # if defined (HAVE_ZLIB)
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
251
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
252 OCTAVE_DEPRECATED (7, "use 'octave::i_c_zfile_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
253 typedef octave::c_file_ptr_stream<std::istream, gzFile, octave::c_zfile_ptr_buf>
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
254 i_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
255
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
256 OCTAVE_DEPRECATED (7, "use 'octave::o_c_zfile_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
257 typedef octave::c_file_ptr_stream<std::ostream, gzFile, octave::c_zfile_ptr_buf>
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
258 o_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
259
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
260 OCTAVE_DEPRECATED (7, "use 'octave::io_c_zfile_ptr_stream' instead")
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
261 typedef octave::c_file_ptr_stream<std::iostream, gzFile, octave::c_zfile_ptr_buf>
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
262 io_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
263
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
264 # endif
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
265
3628
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe]
jwe
parents:
diff changeset
266 #endif
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
267
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
268 #endif