octave: libinterp/corefcn/c-file-ptr-stream.h annotate

annotate libinterp/corefcn/c-file-ptr-stream.h @ 30125:8dd5da409418

maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. * c-file-ptr-stream.cc, c-file-ptr-stream.h, oct-procbuf.cc: Use "m_" prefix for member variables in classes c_file_ptr_buf, c_file_ptr_stream, c_zfile_ptr_buf.

author	Rik <rik@octave.org>
date	Mon, 06 Sep 2021 11:40:04 -0700
parents	3988112c7116
children	a61e1a0f6024

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
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	49 FILE *stdiofile (void) { return m_f; }
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	50
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	51 c_file_ptr_buf (FILE *f, close_fcn cf = file_close)
8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	52 : std::streambuf (), m_f (f), m_cf (cf)
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
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	87 int file_number () const { return m_f ? fileno (m_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
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	93 void clear (void) { if (m_f) clearerr (m_f); }
4888 4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe] jwe parents: 4797 diff changeset	94
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	95 static int file_close (FILE *m_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
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	99 FILE *m_f;
3716 08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3652 diff changeset	100
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	101 close_fcn m_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
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	116 c_file_ptr_stream (FILE_T m_f,
8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	117 typename BUF_T::close_fcn m_cf = BUF_T::file_close)
8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	118 : STREAM_T (nullptr), m_buf (new BUF_T (m_f, m_cf))
8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	119 { STREAM_T::init (m_buf); }
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	120
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	121 // No copying!
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 (const c_file_ptr_stream&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	124
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	125 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	126
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	127 ~c_file_ptr_stream (void) { delete m_buf; m_buf = nullptr; }
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	128
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	129 BUF_T * rdbuf (void) { return m_buf; }
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	130
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	131 void stream_close (void) { if (m_buf) m_buf->buf_close (); }
3652 25e84fcef38a [project @ 2000-03-31 08:50:48 by jwe] jwe parents: 3644 diff changeset	132
16011 8122286c69a9 initial large file support for 32-bit systems John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	133 int seek (off_t offset, int origin)
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	134 { return m_buf ? m_buf->seek (offset, origin) : -1; }
4797 19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4326 diff changeset	135
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	136 off_t tell (void) { return m_buf ? m_buf->tell () : -1; }
4797 19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4326 diff changeset	137
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	138 void clear (void) { if (m_buf) m_buf->clear (); STREAM_T::clear (); }
4888 4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe] jwe parents: 4797 diff changeset	139
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	140 private:
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	141
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	142 BUF_T *m_buf;
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	143 };
168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	144
17787 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::istream, FILE *, c_file_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	146 i_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::ostream, FILE *, c_file_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	148 o_c_file_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	149 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	150 io_c_file_ptr_stream;
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	151
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	152
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	153 #if defined (HAVE_ZLIB)
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	154
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	155 class
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	156 c_zfile_ptr_buf : public std::streambuf
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	157 {
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	158 public:
9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	159
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	160 typedef std::streambuf::int_type int_type;
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 typedef int (*close_fcn) (gzFile);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	163
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	164 gzFile stdiofile (void) { return m_f; }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	165
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	166 c_zfile_ptr_buf (gzFile f, close_fcn cf = file_close)
8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	167 : std::streambuf (), m_f (f), m_cf (cf)
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	168 { }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	169
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	170 // No copying!
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 (const c_zfile_ptr_buf&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	173
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	174 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	175
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	176 ~c_zfile_ptr_buf (void);
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 overflow (int_type);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	179
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	180 int_type underflow (void) { return underflow_common (false); }
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	181
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	182 int_type uflow (void) { return underflow_common (true); }
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 int_type pbackfail (int_type);
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 xsputn (const char*, std::streamsize);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	187
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	188 std::streamsize xsgetn (char *, std::streamsize);
3644 9add655e8b8c [project @ 2000-03-24 11:58:50 by jwe] jwe parents: 3628 diff changeset	189
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	190 std::streampos seekoff (std::streamoff, std::ios::seekdir,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10288 diff changeset	191 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	192
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	193 std::streampos seekpos (std::streampos,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10288 diff changeset	194 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	195
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	196 int sync (void);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	197
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	198 int flush (void);
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	199
10288 5e972e2deffe avoid some possible gnulib #defines John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	200 int buf_close (void);
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	201
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	202 int file_number () const { return -1; }
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	203
16011 8122286c69a9 initial large file support for 32-bit systems John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	204 int seek (off_t offset, int origin)
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	205 { return m_f ? gzseek (m_f, offset, origin) >= 0 : -1; }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	206
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	207 off_t tell (void) { return m_f ? gztell (m_f) : -1; }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	208
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	209 void clear (void) { if (m_f) gzclearerr (m_f); }
4797 19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4326 diff changeset	210
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	211 static int file_close (gzFile m_f) { return ::gzclose (m_f); }
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	212
ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	213 protected:
4797 19b8225bdaa2 [project @ 2004-02-23 22:10:31 by jwe] jwe parents: 4326 diff changeset	214
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	215 gzFile m_f;
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	216
30125 8dd5da409418 maint: use "m_" prefix for member variables in file c-file-ptr-stream.h. Rik <rik@octave.org> parents: 29991 diff changeset	217 close_fcn m_cf;
4888 4a796c5fc7a3 [project @ 2004-04-30 18:27:07 by jwe] jwe parents: 4797 diff changeset	218
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	219 private:
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	220
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	221 int_type underflow_common (bool);
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	222 };
1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	223
17787 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::istream, gzFile, c_zfile_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	225 i_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::ostream, gzFile, c_zfile_ptr_buf>
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	227 o_c_zfile_ptr_stream;
175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	228 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	229 io_c_zfile_ptr_stream;
4326 1cae4472c624 [project @ 2003-02-15 23:14:47 by jwe] jwe parents: 4310 diff changeset	230
5325 ecbe4aa87e51 [project @ 2005-04-29 20:48:35 by jwe] jwe parents: 5307 diff changeset	231 #endif
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	232
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	233 OCTAVE_NAMESPACE_END
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 #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	236
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	237 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	238 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	239
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	240 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	241 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	242
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	243 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	244 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	245
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	246 // 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	247 // 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	248 // 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	249 // 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	250 // 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	251
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	252 # if defined (HAVE_ZLIB)
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	253
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	254 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	255 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	256 i_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	257
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	258 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	259 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	260 o_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	261
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	262 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	263 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	264 io_c_zfile_ptr_stream;
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	265
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	266 # endif
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	267
3628 168c4d71dc63 [project @ 2000-03-23 07:34:54 by jwe] jwe parents: diff changeset	268 #endif
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	269
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	270 #endif

Mercurial > octave

annotate libinterp/corefcn/c-file-ptr-stream.h @ 30125:8dd5da409418