octave_iprocstream Class Reference

#include "oct-prcstrm.h"

Inheritance diagram for octave_iprocstream:

Collaboration diagram for octave_iprocstream:

Public Member Functions
	octave_iprocstream (const octave_iprocstream &)=delete
	octave_iprocstream (const std::string &n, std::ios::openmode arg_md=std::ios::in, octave::mach_info::float_format flt_fmt=octave::mach_info::native_float_format(), const std::string &encoding="utf-8")
bool	bad (void) const
void	clear (void)
void	close (void)
void	do_close (void)
bool	eof (void) const
std::string	error (bool clear, int &err_num)
int	file_number (void) const
std::istream *	input_stream (void)
bool	is_open (void) const
std::string	name (void) const
bool	ok (void) const
octave_iprocstream &	operator= (const octave_iprocstream &)=delete
std::ostream *	output_stream (void)
c_file_ptr_buf *	rdbuf (void) const
int	seek (off_t offset, int origin)
off_t	tell (void)

Static Public Member Functions
static octave::stream	create (const std::string &n, FILE *f=nullptr, std::ios::openmode m=std::ios::in|std::ios::out, octave::mach_info::float_format ff=octave::mach_info::native_float_format(), const std::string &encoding="utf-8", c_file_ptr_buf::close_fcn cf=c_file_ptr_buf::file_close)
static octave::stream	create (const std::string &n, std::ios::openmode arg_md=std::ios::in, octave::mach_info::float_format flt_fmt=octave::mach_info::native_float_format(), const std::string &encoding="utf-8")

Protected Member Functions
	~octave_iprocstream (void)
void	clearerr (void)
std::string	encoding (void) const
void	error (const std::string &msg)
void	error (const std::string &who, const std::string &msg)
mach_info::float_format	float_format (void) const
int	mode (void) const

Protected Attributes
int	fnum
std::ios::openmode	m_mode
std::string	m_name
io_c_file_ptr_stream *	m_stream

Private Member Functions
std::string	do_gets (octave_idx_type max_len, bool &err, bool strip_newline, const std::string &who)
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)
bool	do_oscanf (const scanf_format_elt *elt, octave_value &, const std::string &who)
int	do_printf (printf_format_list &fmt_list, const octave_value_list &args, const std::string &who)
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)
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)
void	field_width_error (const std::string &who) const
int	flush (void)
std::string	getl (octave_idx_type max_len, bool &err, const std::string &who)
std::string	gets (octave_idx_type max_len, bool &err, const std::string &who)
void	invalid_operation (const std::string &who, const char *rw)
octave_value_list	oscanf (const std::string &fmt, const std::string &who)
int	printf (const std::string &fmt, const octave_value_list &args, const std::string &who)
int	puts (const std::string &s, const std::string &who)
octave_value	scanf (const std::string &fmt, const Array< double > &size, octave_idx_type &count, const std::string &who)
off_t	skipl (off_t count, bool &err, const std::string &who)

Private Attributes
std::string	m_encoding
std::string	m_errmsg
bool	m_fail
mach_info::float_format	m_flt_fmt
bool	m_open_state

Detailed Description

Definition at line 36 of file oct-prcstrm.h.

Constructor & Destructor Documentation

octave_iprocstream() [1/2]

octave_iprocstream::octave_iprocstream	(	const std::string &	n,
		std::ios::openmode	arg_md = std::ios::in,
		octave::mach_info::float_format	flt_fmt = octave::mach_info::native_float_format (),
		const std::string &	encoding = "utf-8"
	)

Definition at line 43 of file oct-prcstrm.cc.

octave_iprocstream() [2/2]

octave_iprocstream::octave_iprocstream ( const octave_iprocstream &  )

delete

~octave_iprocstream()

octave_iprocstream::~octave_iprocstream ( void  )

protected

Definition at line 51 of file oct-prcstrm.cc.

References octave_tstdiostream< c_file_ptr_buf, io_c_file_ptr_stream, FILE * >::do_close().

Member Function Documentation

bad()

bool octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::bad ( void  ) const

inlineinherited

Definition at line 95 of file oct-stdstrm.h.

clear()

void octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::clear ( void  )

inlineinherited

Definition at line 97 of file oct-stdstrm.h.

clearerr()

void octave::base_stream::clearerr ( void  )

protectedinherited

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

References octave::base_stream::input_stream(), and octave::base_stream::output_stream().

close()

void octave::base_stream::close ( void  )

inlineinherited

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

create() [1/2]

static octave::stream octave_stdiostream::create ( const std::string &  n, FILE *  f = nullptr, std::ios::openmode  m = std::ios::in | std::ios::out, octave::mach_info::float_format  ff = octave::mach_info::native_float_format (), const std::string &  encoding = "utf-8", c_file_ptr_buf::close_fcn  cf = c_file_ptr_buf::file_close  )

inlinestaticinherited

Definition at line 139 of file oct-stdstrm.h.

References f, m, and n.

Referenced by do_stream_open(), Fmkstemp(), Fpipe(), Fpopen2(), and Ftmpfile().

create() [2/2]

octave::stream octave_iprocstream::create ( const std::string &  n, std::ios::openmode  arg_md = std::ios::in, octave::mach_info::float_format  flt_fmt = octave::mach_info::native_float_format (), const std::string &  encoding = "utf-8"  )

static

Definition at line 36 of file oct-prcstrm.cc.

References octave::base_stream::encoding(), and n.

Referenced by Fpopen().

do_close()

void octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::do_close ( void  )

inlinevirtualinherited

Reimplemented from octave::base_stream.

Definition at line 103 of file oct-stdstrm.h.

do_gets()

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

privateinherited

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

References octave::__get_interpreter__(), octave::base_stream::encoding(), octave::base_stream::error(), octave::base_stream::file_number(), octave::base_stream::input_stream(), octave::interpreter::interactive(), octave::base_stream::invalid_operation(), retval, and octave::string::u8_from_encoding().

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

do_numeric_printf_conv()

int octave::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 5746 of file oct-stream.cc.

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

Referenced by octave::base_stream::do_printf().

do_oscanf()

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

privateinherited

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

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

Referenced by octave::base_stream::oscanf().

do_printf()

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

privateinherited

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

References octave::printf_format_elt::args, octave::base_stream::do_numeric_printf_conv(), octave::do_printf_string(), octave::base_stream::encoding(), octave::base_stream::error(), octave::printf_value_cache::exhausted(), octave::base_stream::field_width_error(), octave::printf_format_list::first(), octave::printf_format_elt::fw, octave::printf_value_cache::get_next_value(), octave::printf_value_cache::int_value(), octave::base_stream::invalid_operation(), octave_value::is_string(), octave_value::isempty(), octave::printf_format_list::next(), octave::printf_format_list::num_conversions(), octave::base_stream::output_stream(), octave::printf_format_elt::prec, retval, octave_value::string_value(), octave::printf_format_elt::text, octave::printf_format_elt::type, and octave::string::u8_to_encoding().

Referenced by octave::base_stream::printf().

do_scanf()

octave_value octave::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 4644 of file oct-stream.cc.

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

Referenced by octave::base_stream::scanf().

do_textscan()

octave_value octave::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 5366 of file oct-stream.cc.

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

encoding()

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

inlineprotectedinherited

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

Referenced by octave_istrstream::create(), create(), octave_oprocstream::create(), octave_ostrstream::create(), octave::base_stream::do_gets(), octave::base_stream::do_numeric_printf_conv(), octave::base_stream::do_printf(), and octave::base_stream::do_textscan().

eof()

bool octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::eof ( void  ) const

inlinevirtualinherited

Implements octave::base_stream.

Definition at line 71 of file oct-stdstrm.h.

error() [1/3]

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

inherited

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

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

Referenced by octave_fstream::octave_fstream(), octave::base_stream::do_gets(), octave::base_stream::do_numeric_printf_conv(), octave::base_stream::do_oscanf(), octave::base_stream::do_printf(), octave::base_stream::do_scanf(), octave::base_stream::do_textscan(), octave::base_stream::field_width_error(), octave::base_stream::invalid_operation(), octave_base_iostream::invalid_operation(), octave::base_stream::oscanf(), octave::base_stream::printf(), octave::base_stream::puts(), octave::base_stream::scanf(), octave_fstream::seek(), octave_base_strstream::seek(), octave::base_stream::skipl(), octave_fstream::tell(), and octave_base_strstream::tell().

error() [2/3]

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

protectedinherited

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

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

error() [3/3]

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

protectedinherited

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

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

field_width_error()

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

privateinherited

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

References octave::base_stream::error().

Referenced by octave::base_stream::do_printf().

file_number()

int octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::file_number ( void  ) const

inlinevirtualinherited

Reimplemented from octave::base_stream.

Definition at line 93 of file oct-stdstrm.h.

float_format()

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

inlineprotectedinherited

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

flush()

int octave::base_stream::flush ( void  )

privateinherited

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

References octave::base_stream::invalid_operation(), octave::base_stream::output_stream(), and retval.

getl()

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

privateinherited

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

References octave::base_stream::do_gets().

gets()

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

privateinherited

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

References octave::base_stream::do_gets().

input_stream()

std::istream* octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::input_stream ( void  )

inlinevirtualinherited

Reimplemented from octave::base_stream.

Definition at line 77 of file oct-stdstrm.h.

invalid_operation()

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

privateinherited

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

References octave::base_stream::error().

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

is_open()

bool octave::base_stream::is_open ( void  ) const

inlineinherited

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

mode()

int octave::base_stream::mode ( void  ) const

inlineprotectedinherited

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

Referenced by octave_fstream::input_stream(), and octave_fstream::output_stream().

name()

std::string octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::name ( void  ) const

inlinevirtualinherited

Implements octave::base_stream.

Definition at line 75 of file oct-stdstrm.h.

ok()

bool octave::base_stream::ok ( void  ) const

inlineinherited

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

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

operator=()

octave_iprocstream& octave_iprocstream::operator= ( const octave_iprocstream &  )

delete

oscanf()

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

privateinherited

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

References octave::base_stream::do_oscanf(), octave::base_stream::error(), octave::scanf_format_list::first(), octave::base_stream::input_stream(), octave::base_stream::invalid_operation(), octave_value::is_defined(), len, octave::scanf_format_list::length(), octave::scanf_format_list::next(), octave::scanf_format_list::num_conversions(), octave::base_stream::ok(), Array< T >::resize(), and retval.

output_stream()

std::ostream* octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::output_stream ( void  )

inlinevirtualinherited

Reimplemented from octave::base_stream.

Definition at line 82 of file oct-stdstrm.h.

printf()

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

privateinherited

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

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

puts()

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

privateinherited

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

References octave::base_stream::error(), octave::base_stream::invalid_operation(), octave::base_stream::output_stream(), and retval.

rdbuf()

c_file_ptr_buf * octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::rdbuf ( void  ) const

inlineinherited

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

scanf()

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

privateinherited

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

References octave::base_stream::do_scanf(), octave::base_stream::error(), octave::get_size(), octave::base_stream::input_stream(), octave::base_stream::invalid_operation(), octave::scanf_format_list::num_conversions(), and retval.

seek()

int octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::seek ( off_t  offset, int  origin  )

inlinevirtualinherited

Implements octave::base_stream.

Definition at line 60 of file oct-stdstrm.h.

skipl()

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

privateinherited

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

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

tell()

off_t octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::tell ( void  )

inlinevirtualinherited

Implements octave::base_stream.

Definition at line 67 of file oct-stdstrm.h.

Member Data Documentation

fnum

int octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::fnum

protectedinherited

Definition at line 118 of file oct-stdstrm.h.

m_encoding

std::string octave::base_stream::m_encoding

privateinherited

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

m_errmsg

std::string octave::base_stream::m_errmsg

privateinherited

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

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

m_fail

bool octave::base_stream::m_fail

privateinherited

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

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

m_flt_fmt

mach_info::float_format octave::base_stream::m_flt_fmt

privateinherited

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

m_mode

std::ios::openmode octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::m_mode

protectedinherited

Definition at line 113 of file oct-stdstrm.h.

m_name

std::string octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::m_name

protectedinherited

Definition at line 111 of file oct-stdstrm.h.

m_open_state

bool octave::base_stream::m_open_state

privateinherited

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

m_stream

io_c_file_ptr_stream * octave_tstdiostream< c_file_ptr_buf , io_c_file_ptr_stream , FILE * >::m_stream

protectedinherited

Definition at line 115 of file oct-stdstrm.h.

---

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

• libinterp/corefcn/oct-prcstrm.h
• libinterp/corefcn/oct-prcstrm.cc