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

annotate libinterp/corefcn/oct-iostrm.h @ 33617:ec2635a02328 bytecode-interpreter tip

maint: Merge default to bytecode-interpreter.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 21 May 2024 18:29:03 +0200
parents	4b601ca024d5
children

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 //
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31855 diff changeset	3 // Copyright (C) 1996-2024 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
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	35 OCTAVE_BEGIN_NAMESPACE(octave)
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	36
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	37 class base_iostream : public base_stream
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	38 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	39 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	40
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	41 base_iostream (const std::string& n = "",
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	42 std::ios::openmode m = std::ios::in \| std::ios::out,
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	43 mach_info::float_format ff = mach_info::native_float_format ())
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	44 : base_stream (m, ff), m_name (n) { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	45
31837 febd82d1a8de use new macros to consistently delete copy and move member functions John W. Eaton <jwe@octave.org> parents: 31771 diff changeset	46 OCTAVE_DISABLE_COPY_MOVE (base_iostream)
22869 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 protected:
f75d289645ec make deleted functions public John W. Eaton <jwe@octave.org> parents: 22868 diff changeset	49
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	50 ~base_iostream () = default;
22869 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 public:
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	53
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	54 // Position a stream at OFFSET relative to ORIGIN.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	55
16011 8122286c69a9 initial large file support for 32-bit systems John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	56 int seek (off_t offset, int origin);
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 // Return current stream position.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	59
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	60 off_t tell ();
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	61
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	62 // 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	63
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	64 bool eof () const;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	65
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	66 // The name of the file.
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	67
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	68 std::string name () const { return m_name; }
2081 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 protected:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	71
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	72 void invalid_operation () const;
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 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	75
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	76 std::string m_name;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	77
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	78 virtual const char * stream_type () const = 0;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	79 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	80
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	81 class istream : public base_iostream
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	82 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	83 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	84
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	85 istream (std::istream *arg = nullptr, const std::string& n = "")
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	86 : base_iostream (n, std::ios::in, mach_info::native_float_format ()),
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	87 m_istream (arg)
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	88 { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	89
31837 febd82d1a8de use new macros to consistently delete copy and move member functions John W. Eaton <jwe@octave.org> parents: 31771 diff changeset	90 OCTAVE_DISABLE_COPY_MOVE (istream)
febd82d1a8de use new macros to consistently delete copy and move member functions John W. Eaton <jwe@octave.org> parents: 31771 diff changeset	91
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	92 static stream
23457 21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible. Rik <rik@octave.org> parents: 23446 diff changeset	93 create (std::istream *arg = nullptr, const std::string& n = "");
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	94
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	95 // 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	96
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	97 bool eof () const;
3342 d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	98
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	99 std::istream * input_stream () { return m_istream; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	100
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	101 std::ostream * output_stream () { return nullptr; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	102
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	103 protected:
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	104
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	105 ~istream () = default;
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	106
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	107 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	108
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	109 std::istream *m_istream;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	110
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	111 const char * stream_type () const { return "istream"; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	112 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	113
32628 ae4e19c0a2b1 maint: Place class name and class keyword on one line. Rik <rik@octave.org> parents: 31855 diff changeset	114 class ostream : public base_iostream
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	115 {
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	116 public:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	117
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	118 ostream (std::ostream *arg, const std::string& n = "")
3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	119 : base_iostream (n, std::ios::out, mach_info::native_float_format ()),
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	120 m_ostream (arg)
5015 6d481b6e349e [project @ 2004-09-22 02:18:13 by jwe] jwe parents: 4797 diff changeset	121 { }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	122
31855 1daf8bfceac3 default or disable more ctors, dtors, and assignment ops John W. Eaton <jwe@octave.org> parents: 31837 diff changeset	123 OCTAVE_DISABLE_CONSTRUCT_COPY_MOVE (ostream)
31837 febd82d1a8de use new macros to consistently delete copy and move member functions John W. Eaton <jwe@octave.org> parents: 31771 diff changeset	124
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	125 static stream
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	126 create (std::ostream *arg, const std::string& n = "");
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	127
18812 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17822 diff changeset	128 // 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	129
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	130 bool eof () const;
3342 d8d3700fb4ab [project @ 1999-11-05 16:55:17 by jwe] jwe parents: 3340 diff changeset	131
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	132 std::istream * input_stream () { return nullptr; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	133
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	134 std::ostream * output_stream () { return m_ostream; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	135
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	136 protected:
585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	137
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	138 ~ostream () = default;
3340 585a8809fd9b [project @ 1999-11-05 07:02:30 by jwe] jwe parents: 2877 diff changeset	139
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	140 private:
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	141
27172 b0abae0bd94b style fixes John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	142 std::ostream *m_ostream;
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	143
31771 21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations. Rik <rik@octave.org> parents: 31707 diff changeset	144 const char * stream_type () const { return "ostream"; }
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	145 };
e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	146
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	147 OCTAVE_END_NAMESPACE(octave)
29991 3988112c7116 move i/o stream classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	148
2081 e9ec222a53e1 [project @ 1996-04-25 03:17:36 by jwe] jwe parents: diff changeset	149 #endif

Mercurial > octave

annotate libinterp/corefcn/oct-iostrm.h @ 33617:ec2635a02328 bytecode-interpreter tip