Mercurial > octave-libtiff
view libinterp/corefcn/oct-iostrm.h @ 31215:0fb5ca242d66
__tiff__.cc: added documentation to all internal functions
* libtinterp/corefcn/__tiff__.cc: Added documentation to all internal
functions to enable using help and print_usage.
author | magedrifaat <magedrifaat@gmail.com> |
---|---|
date | Wed, 07 Sep 2022 18:00:04 +0200 |
parents | 796f54d4ddbf |
children |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_oct_iostrm_h) #define octave_oct_iostrm_h 1 #include "octave-config.h" #include <iosfwd> #include "oct-stream.h" OCTAVE_NAMESPACE_BEGIN class base_iostream : public base_stream { public: base_iostream (const std::string& n = "", std::ios::openmode m = std::ios::in | std::ios::out, mach_info::float_format ff = mach_info::native_float_format ()) : base_stream (m, ff), m_name (n) { } // No copying! base_iostream (const base_iostream&) = delete; base_iostream& operator = (const base_iostream&) = delete; protected: ~base_iostream (void) = default; public: // Position a stream at OFFSET relative to ORIGIN. int seek (off_t offset, int origin); // Return current stream position. off_t tell (void); // Return nonzero if EOF has been reached on this stream. bool eof (void) const; // The name of the file. std::string name (void) const { return m_name; } protected: void invalid_operation (void) const; private: std::string m_name; virtual const char * stream_type (void) const = 0; }; class istream : public base_iostream { public: istream (std::istream *arg = nullptr, const std::string& n = "") : base_iostream (n, std::ios::in, mach_info::native_float_format ()), m_istream (arg) { } static stream create (std::istream *arg = nullptr, const std::string& n = ""); // Return nonzero if EOF has been reached on this stream. bool eof (void) const; std::istream * input_stream (void) { return m_istream; } std::ostream * output_stream (void) { return nullptr; } protected: ~istream (void) = default; private: std::istream *m_istream; const char * stream_type (void) const { return "istream"; } // No copying! istream (const istream&) = delete; istream& operator = (const istream&) = delete; }; class ostream : public base_iostream { public: ostream (std::ostream *arg, const std::string& n = "") : base_iostream (n, std::ios::out, mach_info::native_float_format ()), m_ostream (arg) { } static stream create (std::ostream *arg, const std::string& n = ""); // Return nonzero if EOF has been reached on this stream. bool eof (void) const; std::istream * input_stream (void) { return nullptr; } std::ostream * output_stream (void) { return m_ostream; } protected: ~ostream (void) = default; private: std::ostream *m_ostream; const char * stream_type (void) const { return "ostream"; } // No copying! ostream (const ostream&) = delete; ostream& operator = (const ostream&) = delete; }; OCTAVE_NAMESPACE_END #if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS) OCTAVE_DEPRECATED (7, "use 'octave::base_iostream' instead") typedef octave::base_iostream octave_base_iostream; OCTAVE_DEPRECATED (7, "use 'octave::istream' instead") typedef octave::istream octave_istream; OCTAVE_DEPRECATED (7, "use 'octave::ostream' instead") typedef octave::ostream octave_ostream; #endif #endif