GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
fstream Class Reference

#include "oct-fstrm.h"

Inheritance diagram for fstream:
Inheritance graph
[legend]
Collaboration diagram for fstream:
Collaboration graph
[legend]

Public Member Functions

 fstream (const fstream &)=delete
 
 fstream (const std::string &nm_arg, std::ios::openmode arg_md=std::ios::in|std::ios::out, mach_info::float_format flt_fmt=mach_info::native_float_format())
 
void close (void)
 
void do_close (void)
 
bool eof (void) const
 
std::string error (bool clear, int &err_num)
 
virtual int file_number (void) const
 
std::istream * input_stream (void)
 
bool is_open (void) const
 
std::string name (void) const
 
bool ok (void) const
 
fstream & operator= (const fstream &)=delete
 
std::ostream * output_stream (void)
 
std::ostream * preferred_output_stream (void)
 
int seek (off_t offset, int origin)
 
off_t tell (void)
 

Static Public Member Functions

static stream create (const std::string &nm_arg, std::ios::openmode arg_md=std::ios::in|std::ios::out, mach_info::float_format flt_fmt=mach_info::native_float_format())
 

Protected Member Functions

 ~fstream (void)=default
 
OCTINTERP_API void clear (void)
 
OCTINTERP_API void clearerr (void)
 
std::string encoding (void) const
 
OCTINTERP_API void error (const std::string &msg)
 
OCTINTERP_API void error (const std::string &who, const std::string &msg)
 
mach_info::float_format float_format (void) const
 
int mode (void) const
 

Private Types

typedef string::deletable_facet< string::codecvt_u8 > convfacet_u8
 

Private Member Functions

OCTINTERP_API std::string do_gets (octave_idx_type max_len, bool &err, bool strip_newline, const std::string &who)
 
OCTINTERP_API int do_numeric_printf_conv (std::ostream &os, const printf_format_elt *elt, int nsa, int sa_1, int sa_2, const octave_value &val, const std::string &who)
 
OCTINTERP_API bool do_oscanf (const scanf_format_elt *elt, octave_value &, const std::string &who)
 
OCTINTERP_API int do_printf (printf_format_list &fmt_list, const octave_value_list &args, const std::string &who)
 
OCTINTERP_API octave_value do_scanf (scanf_format_list &fmt_list, octave_idx_type nr, octave_idx_type nc, bool one_elt_size_spec, octave_idx_type &count, const std::string &who)
 
OCTINTERP_API octave_value do_textscan (const std::string &fmt, octave_idx_type ntimes, const octave_value_list &options, const std::string &who, octave_idx_type &count)
 
OCTINTERP_API void field_width_error (const std::string &who) const
 
OCTINTERP_API int flush (void)
 
OCTINTERP_API std::string getl (octave_idx_type max_len, bool &err, const std::string &who)
 
OCTINTERP_API std::string gets (octave_idx_type max_len, bool &err, const std::string &who)
 
OCTINTERP_API void invalid_operation (const std::string &who, const char *rw)
 
OCTINTERP_API octave_value_list oscanf (const std::string &fmt, const std::string &who)
 
OCTINTERP_API int printf (const std::string &fmt, const octave_value_list &args, const std::string &who)
 
OCTINTERP_API int puts (const std::string &s, const std::string &who)
 
OCTINTERP_API octave_value scanf (const std::string &fmt, const Array< double > &size, octave_idx_type &count, const std::string &who)
 
OCTINTERP_API off_t skipl (off_t count, bool &err, const std::string &who)
 

Private Attributes

std::ostream * m_conv_ostream
 
std::string m_encoding
 
std::string m_errmsg
 
bool m_fail
 
mach_info::float_format m_flt_fmt
 
std::fstream m_fstream
 
int m_mode
 
std::string m_name
 
bool m_open_state
 

Detailed Description

Definition at line 38 of file oct-fstrm.h.

Member Typedef Documentation

◆ convfacet_u8

typedef string::deletable_facet<string::codecvt_u8> base_stream::convfacet_u8
privateinherited

Definition at line 215 of file oct-stream.h.

Constructor & Destructor Documentation

◆ fstream() [1/2]

fstream::fstream ( const std::string &  nm_arg,
std::ios::openmode  arg_md = std::ios::in | std::ios::out,
mach_info::float_format  flt_fmt = mach_info::native_float_format () 
)

Definition at line 45 of file oct-fstrm.cc.

References base_stream::error(), m_fstream, and m_name.

◆ fstream() [2/2]

fstream::fstream ( const fstream &  )
delete

◆ ~fstream()

fstream::~fstream ( void  )
protecteddefault

Member Function Documentation

◆ clear()

void base_stream::clear ( void  )
protectedinherited

Definition at line 4087 of file oct-stream.cc.

References base_stream::m_errmsg, and base_stream::m_fail.

Referenced by base_stream::error().

◆ clearerr()

void base_stream::clearerr ( void  )
protectedinherited

Definition at line 4094 of file oct-stream.cc.

References base_stream::input_stream(), and base_stream::preferred_output_stream().

◆ close()

void base_stream::close ( void  )
inlineinherited

Definition at line 152 of file oct-stream.h.

References stream::is_open().

◆ create()

stream fstream::create ( const std::string &  nm_arg,
std::ios::openmode  arg_md = std::ios::in | std::ios::out,
mach_info::float_format  flt_fmt = mach_info::native_float_format () 
)
static

Definition at line 39 of file oct-fstrm.cc.

References base_stream::stream.

◆ do_close()

void fstream::do_close ( void  )
virtual

Reimplemented from base_stream.

Definition at line 87 of file oct-fstrm.cc.

References m_fstream.

◆ do_gets()

std::string base_stream::do_gets ( octave_idx_type  max_len,
bool &  err,
bool  strip_newline,
const std::string &  who 
)
privateinherited

Definition at line 4110 of file oct-stream.cc.

References __get_interpreter__(), base_stream::encoding(), base_stream::error(), base_stream::file_number(), base_stream::input_stream(), interpreter::interactive(), base_stream::invalid_operation(), u8_from_encoding(), and textscan_format_list::who.

Referenced by base_stream::do_oscanf(), base_stream::do_scanf(), base_stream::getl(), and base_stream::gets().

◆ do_numeric_printf_conv()

int base_stream::do_numeric_printf_conv ( std::ostream &  os,
const printf_format_elt *  elt,
int  nsa,
int  sa_1,
int  sa_2,
const octave_value &  val,
const std::string &  who 
)
privateinherited

Definition at line 5816 of file oct-stream.cc.

References do_printf_conv(), octave_value::double_value(), base_stream::error(), printf_format_elt::flags, octave_value::int64_scalar_value(), is_nan_or_inf(), lo_ieee_is_NA, lo_ieee_isinf, ok_for_signed_int_conv(), ok_for_unsigned_int_conv(), printf_format_elt::prec, switch_to_g_format(), printf_format_elt::text, printf_format_elt::type, octave_value::uint64_scalar_value(), octave_int< T >::value(), and textscan_format_list::who.

Referenced by base_stream::do_printf().

◆ do_oscanf()

bool base_stream::do_oscanf ( const scanf_format_elt *  elt,
octave_value &  retval,
const std::string &  who 
)
privateinherited

Definition at line 5151 of file oct-stream.cc.

References __get_interpreter__(), BEGIN_C_CONVERSION, BEGIN_CHAR_CLASS_CONVERSION, BEGIN_S_CONVERSION, scanf_format_elt::discard, base_stream::do_gets(), DO_LITERAL_CONVERSION, DO_PCT_CONVERSION, DO_WHITESPACE_CONVERSION, base_stream::error(), application::forced_interactive(), base_stream::input_stream(), interpreter::interactive(), scanf_format_elt::literal_conversion, scanf_format_elt::modifier, base_stream::name(), octave_scan(), base_stream::ok(), scanf_format_elt::text, scanf_format_elt::type, scanf_format_elt::whitespace_conversion, and textscan_format_list::who.

Referenced by base_stream::oscanf().

◆ do_printf()

int base_stream::do_printf ( printf_format_list &  fmt_list,
const octave_value_list &  args,
const std::string &  who 
)
privateinherited

Definition at line 5943 of file oct-stream.cc.

References printf_format_elt::args, base_stream::do_numeric_printf_conv(), do_printf_string(), base_stream::error(), printf_value_cache::exhausted(), base_stream::field_width_error(), printf_format_list::first(), printf_format_elt::fw, printf_value_cache::get_next_value(), printf_value_cache::int_value(), base_stream::invalid_operation(), octave_value::is_string(), octave_value::isempty(), textscan_format_list::m_nconv, printf_format_list::next(), printf_format_list::num_conversions(), printf_format_elt::prec, base_stream::preferred_output_stream(), octave_value::string_value(), printf_format_elt::text, printf_format_elt::type, and textscan_format_list::who.

Referenced by base_stream::printf().

◆ do_scanf()

octave_value base_stream::do_scanf ( scanf_format_list &  fmt_list,
octave_idx_type  nr,
octave_idx_type  nc,
bool  one_elt_size_spec,
octave_idx_type &  count,
const std::string &  who 
)
privateinherited

Definition at line 4719 of file oct-stream.cc.

References __get_interpreter__(), scanf_format_list::all_character_conversions(), BEGIN_C_CONVERSION, BEGIN_CHAR_CLASS_CONVERSION, BEGIN_S_CONVERSION, octave_value::convert_to_str(), scanf_format_elt::discard, base_stream::do_gets(), DO_LITERAL_CONVERSION, DO_PCT_CONVERSION, do_scanf_conv(), DO_WHITESPACE_CONVERSION, base_stream::error(), base_stream::file_number(), FINISH_CHARACTER_CONVERSION, scanf_format_list::first(), application::forced_interactive(), Array< T, Alloc >::fortran_vec(), base_stream::input_stream(), interpreter::interactive(), scanf_format_list::length(), scanf_format_elt::literal_conversion, textscan_format_list::m_nconv, Matrix, scanf_format_elt::modifier, base_stream::name(), scanf_format_list::next(), scanf_format_elt::null, scanf_format_list::num_conversions(), base_stream::ok(), panic_impossible, Matrix::resize(), scanf_format_elt::text, scanf_format_elt::type, scanf_format_elt::whitespace_conversion, and textscan_format_list::who.

Referenced by base_stream::scanf().

◆ do_textscan()

octave_value base_stream::do_textscan ( const std::string &  fmt,
octave_idx_type  ntimes,
const octave_value_list &  options,
const std::string &  who,
octave_idx_type &  count 
)
privateinherited

Definition at line 5441 of file oct-stream.cc.

References __get_interpreter__(), base_stream::encoding(), base_stream::error(), base_stream::file_number(), base_stream::input_stream(), interpreter::interactive(), base_stream::invalid_operation(), scanner, and textscan_format_list::who.

◆ encoding()

std::string base_stream::encoding ( void  ) const
inlineprotectedinherited

Definition at line 187 of file oct-stream.h.

Referenced by istrstream::create(), ostrstream::create(), base_stream::do_gets(), and base_stream::do_textscan().

◆ eof()

bool fstream::eof ( void  ) const
virtual

Implements base_stream.

Definition at line 81 of file oct-fstrm.cc.

References m_fstream.

◆ error() [1/3]

std::string base_stream::error ( bool  clear,
int &  err_num 
)
inherited

Definition at line 6115 of file oct-stream.cc.

References base_stream::clear(), base_stream::m_errmsg, and base_stream::m_fail.

Referenced by fstream(), base_stream::do_gets(), base_stream::do_numeric_printf_conv(), base_stream::do_oscanf(), base_stream::do_printf(), base_stream::do_scanf(), base_stream::do_textscan(), base_stream::field_width_error(), base_stream::invalid_operation(), base_iostream::invalid_operation(), base_stream::oscanf(), base_stream::printf(), base_stream::puts(), base_stream::scanf(), seek(), base_strstream::seek(), base_stream::skipl(), tell(), and base_strstream::tell().

◆ error() [2/3]

void base_stream::error ( const std::string &  msg)
protectedinherited

Definition at line 4073 of file oct-stream.cc.

References base_stream::m_errmsg, and base_stream::m_fail.

◆ error() [3/3]

void base_stream::error ( const std::string &  who,
const std::string &  msg 
)
protectedinherited

Definition at line 4080 of file oct-stream.cc.

References base_stream::m_errmsg, base_stream::m_fail, and textscan_format_list::who.

◆ field_width_error()

void base_stream::field_width_error ( const std::string &  who) const
privateinherited

Definition at line 5936 of file oct-stream.cc.

References base_stream::error(), and textscan_format_list::who.

Referenced by base_stream::do_printf().

◆ file_number()

virtual int base_stream::file_number ( void  ) const
inlinevirtualinherited

Reimplemented in tstdiostream< BUF_T, STREAM_T, FILE_T >, tstdiostream< c_file_ptr_buf, io_c_file_ptr_stream, FILE * >, and tstdiostream< c_zfile_ptr_buf, io_c_zfile_ptr_stream, gzFile >.

Definition at line 161 of file oct-stream.h.

References stream::name().

Referenced by base_stream::do_gets(), base_stream::do_scanf(), base_stream::do_textscan(), and base_stream::skipl().

◆ float_format()

mach_info::float_format base_stream::float_format ( void  ) const
inlineprotectedinherited

Definition at line 185 of file oct-stream.h.

◆ flush()

int base_stream::flush ( void  )
privateinherited

Definition at line 5473 of file oct-stream.cc.

References base_stream::invalid_operation(), and base_stream::preferred_output_stream().

◆ getl()

std::string base_stream::getl ( octave_idx_type  max_len,
bool &  err,
const std::string &  who 
)
privateinherited

Definition at line 4214 of file oct-stream.cc.

References base_stream::do_gets(), and textscan_format_list::who.

◆ gets()

std::string base_stream::gets ( octave_idx_type  max_len,
bool &  err,
const std::string &  who 
)
privateinherited

Definition at line 4221 of file oct-stream.cc.

References base_stream::do_gets(), and textscan_format_list::who.

◆ input_stream()

std::istream * fstream::input_stream ( void  )
virtual

Reimplemented from base_stream.

Definition at line 93 of file oct-fstrm.cc.

References m_fstream, and base_stream::mode().

◆ invalid_operation()

void base_stream::invalid_operation ( const std::string &  who,
const char *  rw 
)
privateinherited

Definition at line 6128 of file oct-stream.cc.

References base_stream::error(), and textscan_format_list::who.

Referenced by base_stream::do_gets(), base_stream::do_printf(), base_stream::do_textscan(), base_stream::flush(), base_stream::oscanf(), base_stream::puts(), base_stream::scanf(), and base_stream::skipl().

◆ is_open()

bool base_stream::is_open ( void  ) const
inlineinherited

Definition at line 148 of file oct-stream.h.

◆ mode()

int base_stream::mode ( void  ) const
inlineprotectedinherited

Definition at line 183 of file oct-stream.h.

Referenced by input_stream(), and output_stream().

◆ name()

std::string fstream::name ( void  ) const
inlinevirtual

Implements base_stream.

Definition at line 74 of file oct-fstrm.h.

◆ ok()

bool base_stream::ok ( void  ) const
inlineinherited

Definition at line 175 of file oct-stream.h.

Referenced by base_stream::do_oscanf(), base_stream::do_scanf(), and base_stream::oscanf().

◆ operator=()

fstream& fstream::operator= ( const fstream &  )
delete

◆ oscanf()

octave_value_list base_stream::oscanf ( const std::string &  fmt,
const std::string &  who 
)
privateinherited

Definition at line 5367 of file oct-stream.cc.

References base_stream::do_oscanf(), base_stream::error(), scanf_format_list::first(), base_stream::input_stream(), base_stream::invalid_operation(), octave_value::is_defined(), len, scanf_format_list::length(), textscan_format_list::m_nconv, scanf_format_list::next(), scanf_format_list::num_conversions(), base_stream::ok(), octave_value_list::resize(), and textscan_format_list::who.

◆ output_stream()

std::ostream * fstream::output_stream ( void  )
virtual

Reimplemented from base_stream.

Definition at line 104 of file oct-fstrm.cc.

References m_fstream, and base_stream::mode().

◆ preferred_output_stream()

std::ostream* base_stream::preferred_output_stream ( void  )
inlineinherited

Definition at line 124 of file oct-stream.h.

References stream::output_stream().

Referenced by base_stream::clearerr(), base_stream::do_printf(), base_stream::flush(), and base_stream::puts().

◆ printf()

int base_stream::printf ( const std::string &  fmt,
const octave_value_list &  args,
const std::string &  who 
)
privateinherited

Definition at line 6063 of file oct-stream.cc.

References base_stream::do_printf(), base_stream::error(), printf_format_list::num_conversions(), and textscan_format_list::who.

◆ puts()

int base_stream::puts ( const std::string &  s,
const std::string &  who 
)
privateinherited

Definition at line 6076 of file oct-stream.cc.

References base_stream::error(), base_stream::invalid_operation(), base_stream::preferred_output_stream(), and textscan_format_list::who.

◆ scanf()

octave_value base_stream::scanf ( const std::string &  fmt,
const Array< double > &  size,
octave_idx_type &  count,
const std::string &  who 
)
privateinherited

Definition at line 5117 of file oct-stream.cc.

References base_stream::do_scanf(), base_stream::error(), get_size(), base_stream::input_stream(), base_stream::invalid_operation(), Matrix, scanf_format_list::num_conversions(), and textscan_format_list::who.

◆ seek()

int fstream::seek ( off_t  offset,
int  origin 
)
virtual

Implements base_stream.

Definition at line 59 of file oct-fstrm.cc.

References base_stream::error().

◆ skipl()

off_t base_stream::skipl ( off_t  count,
bool &  err,
const std::string &  who 
)
privateinherited

Definition at line 4228 of file oct-stream.cc.

References __get_interpreter__(), base_stream::error(), base_stream::file_number(), base_stream::input_stream(), interpreter::interactive(), base_stream::invalid_operation(), and textscan_format_list::who.

◆ tell()

off_t fstream::tell ( void  )
virtual

Implements base_stream.

Definition at line 70 of file oct-fstrm.cc.

References base_stream::error().

Member Data Documentation

◆ m_conv_ostream

std::ostream* base_stream::m_conv_ostream
privateinherited

Definition at line 225 of file oct-stream.h.

◆ m_encoding

std::string base_stream::m_encoding
privateinherited

Definition at line 212 of file oct-stream.h.

◆ m_errmsg

std::string base_stream::m_errmsg
privateinherited

Definition at line 234 of file oct-stream.h.

Referenced by base_stream::clear(), and base_stream::error().

◆ m_fail

bool base_stream::m_fail
privateinherited

Definition at line 228 of file oct-stream.h.

Referenced by base_stream::clear(), and base_stream::error().

◆ m_flt_fmt

mach_info::float_format base_stream::m_flt_fmt
privateinherited

Definition at line 209 of file oct-stream.h.

◆ m_fstream

std::fstream fstream::m_fstream
private

Definition at line 88 of file oct-fstrm.h.

Referenced by fstream(), do_close(), eof(), input_stream(), and output_stream().

◆ m_mode

int base_stream::m_mode
privateinherited

Definition at line 206 of file oct-stream.h.

◆ m_name

std::string fstream::m_name
private

Definition at line 86 of file oct-fstrm.h.

Referenced by fstream().

◆ m_open_state

bool base_stream::m_open_state
privateinherited

Definition at line 231 of file oct-stream.h.

The documentation for this class was generated from the following files: