octave: libinterp/corefcn/oct-iostrm.h annotate

annotate libinterp/corefcn/oct-iostrm.h @ 29358:0a5b15007766 stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021.

author	John W. Eaton <jwe@octave.org>
date	Wed, 10 Feb 2021 09:52:15 -0500
parents	bd51beb6205e
children	3988112c7116

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) 1996-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 ////////////////////////////////////////////////////////////////////////
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_oct_iostrm_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17744 diff changeset	27 #define octave_oct_iostrm_h 1
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30
8950 d865363208d6 include <iosfwd> instead of <iostream> in header files John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	31 #include <iosfwd>
2877 5c1b9e545dd1 [project @ 1997-04-24 09:07:39 by jwe] jwe parents: 2847 diff changeset	32
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	33 #include "oct-stream.h"
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	34
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	35 class
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	36 octave_base_iostream : public octave::base_stream
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	37 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	38 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	39
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	40 octave_base_iostream (const std::string& n = "",
21662 5b9868c2e212 maint: Octave coding convention cleanups. Rik <rik@octave.org> parents: 21244 diff changeset	41 std::ios::openmode m = std::ios::in \| std::ios::out,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21662 diff changeset	42 octave::mach_info::float_format ff
c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21662 diff changeset	43 = octave::mach_info::native_float_format ())
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	44 : octave::base_stream (m, ff), m_name (n) { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	45
22869 f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	46 // No copying!
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	47
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	48 octave_base_iostream (const octave_base_iostream&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	49
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	50 octave_base_iostream& operator = (const octave_base_iostream&) = delete;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	51
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	52 protected:
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	53
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	54 ~octave_base_iostream (void) = default;
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	55
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	56 public:
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	57
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	58 // Position a stream at OFFSET relative to ORIGIN.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	59
16011 8122286c69a9 initial large file support for 32-bit systems John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	60 int seek (off_t offset, int origin);
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	61
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	62 // Return current stream position.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	63
16011 8122286c69a9 initial large file support for 32-bit systems John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	64 off_t tell (void);
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	65
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	66 // Return nonzero if EOF has been reached on this stream.
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	67
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	68 bool eof (void) const;
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	69
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	70 // The name of the file.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	71
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	72 std::string name (void) const { return m_name; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	73
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	74 protected:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	75
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	76 void invalid_operation (void) const;
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	77
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	78 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	79
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	80 std::string m_name;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	81
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	82 virtual const char * stream_type (void) const = 0;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	83 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	84
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	85 class
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	86 octave_istream : public octave_base_iostream
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	87 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	88 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	89
23457 21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible. Rik <rik@octave.org> parents: 23446 diff changeset	90 octave_istream (std::istream *arg = nullptr, const std::string& n = "")
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	91 : octave_base_iostream (n, std::ios::in,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21662 diff changeset	92 octave::mach_info::native_float_format ()),
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	93 m_istream (arg)
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	94 { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	95
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	96 static octave::stream
23457 21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible. Rik <rik@octave.org> parents: 23446 diff changeset	97 create (std::istream *arg = nullptr, const std::string& n = "");
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	98
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	99 // Return nonzero if EOF has been reached on this stream.
3342 d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	100
d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	101 bool eof (void) const;
d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	102
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	103 std::istream * input_stream (void) { return m_istream; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	104
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23457 diff changeset	105 std::ostream * output_stream (void) { return nullptr; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	106
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	107 protected:
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	108
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	109 ~octave_istream (void) = default;
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	110
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	111 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	112
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	113 std::istream *m_istream;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	114
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	115 const char * stream_type (void) const { return "octave_istream"; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	116
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	117 // No copying!
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	118
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	119 octave_istream (const octave_istream&) = delete;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	120
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	121 octave_istream& operator = (const octave_istream&) = delete;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	122 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	123
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	124 class
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	125 octave_ostream : public octave_base_iostream
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	126 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	127 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	128
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	129 octave_ostream (std::ostream *arg, const std::string& n = "")
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	130 : octave_base_iostream (n, std::ios::out,
21739 c4ab2e54f100 use namespace for oct_mach_info class John W. Eaton <jwe@octave.org> parents: 21662 diff changeset	131 octave::mach_info::native_float_format ()),
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	132 m_ostream (arg)
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	133 { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	134
23059 b98ebcd7f11c move some octave stream classes into octave namespace John W. Eaton <jwe@octave.org> parents: 22869 diff changeset	135 static octave::stream
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	136 create (std::ostream *arg, const std::string& n = "");
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	137
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	138 // Return nonzero if EOF has been reached on this stream.
3342 d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	139
d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	140 bool eof (void) const;
d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	141
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23457 diff changeset	142 std::istream * input_stream (void) { return nullptr; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	143
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	144 std::ostream * output_stream (void) { return m_ostream; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	145
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	146 protected:
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	147
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22865 diff changeset	148 ~octave_ostream (void) = default;
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	149
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	150 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	151
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	152 std::ostream *m_ostream;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	153
23446 cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers. Rik <rik@octave.org> parents: 23220 diff changeset	154 const char * stream_type (void) const { return "octave_ostream"; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	155
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	156 // No copying!
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	157
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	158 octave_ostream (const octave_ostream&) = delete;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	159
22865 89756f2f085b use c++11 style for deleting default copy constructor and assignment operator John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	160 octave_ostream& operator = (const octave_ostream&) = delete;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	161 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	162
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	163 #endif

Mercurial > octave

annotate libinterp/corefcn/oct-iostrm.h @ 29358:0a5b15007766 stable