octave::textscan Class Reference

Collaboration diagram for octave::textscan:

Public Member Functions
	textscan (const std::string &who_arg="textscan", const std::string &encoding="utf-8")
	textscan (const textscan &)=delete
	~textscan (void)=default
textscan &	operator= (const textscan &)=delete
octave_value	scan (std::istream &isp, const std::string &fmt, octave_idx_type ntimes, const octave_value_list &options, octave_idx_type &read_count)

Private Member Functions
octave_value	do_scan (std::istream &isp, textscan_format_list &fmt_list, octave_idx_type ntimes)
bool	is_delim (unsigned char ch) const
bool	isspace (unsigned int ch) const
int	lookahead (delimited_stream &is, const Cell &targets, int max_len, bool case_sensitive=true) const
bool	match_literal (delimited_stream &isp, const textscan_format_elt &elem)
void	parse_options (const octave_value_list &args, textscan_format_list &fmt_list)
double	read_double (delimited_stream &is, const textscan_format_elt &fmt) const
int	read_format_once (delimited_stream &isp, textscan_format_list &fmt_list, std::list< octave_value > &retval, Array< octave_idx_type > row, int &done_after)
std::string	read_until (delimited_stream &is, const Cell &delimiters, const std::string &ends) const
int	scan_bracket (delimited_stream &is, const std::string &pattern, std::string &val) const
int	scan_caret (delimited_stream &is, const std::string &pattern, std::string &val) const
void	scan_complex (delimited_stream &is, const textscan_format_elt &fmt, Complex &val) const
void	scan_cstring (delimited_stream &is, const textscan_format_elt &fmt, std::string &val) const
void	scan_one (delimited_stream &is, const textscan_format_elt &fmt, octave_value &ov, Array< octave_idx_type > row)
void	scan_qstring (delimited_stream &is, const textscan_format_elt &fmt, std::string &val)
void	scan_string (delimited_stream &is, const textscan_format_elt &fmt, std::string &val) const
int	skip_delim (delimited_stream &is)
int	skip_whitespace (delimited_stream &is, bool EOLstop=true)
bool	whitespace_delim (void) const

Private Attributes
std::string	m_buf
octave_idx_type	m_buffer_size
bool	m_collect_output
int	m_comment_char
int	m_comment_len
Cell	m_comment_style
std::string	m_date_locale
bool	m_default_exp
int	m_delim_len
Cell	m_delim_list
std::string	m_delim_table
std::string	m_delims
octave_value	m_empty_value
std::string	m_encoding
short	m_eol1
short	m_eol2
std::string	m_exp_chars
int	m_header_lines
Cell	m_inf_nan
octave_idx_type	m_lines
short	m_return_on_error
Cell	m_treat_as_empty
int	m_treat_as_empty_len
std::string	m_whitespace
std::string	m_whitespace_table
std::string	m_who
bool	multiple_delims_as_one

Friends
class	textscan_format_list

Detailed Description

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

Constructor & Destructor Documentation

textscan() [1/2]

octave::textscan::textscan	(	const std::string &	who_arg = "textscan",
		const std::string &	encoding = "utf-8"
	)

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

textscan() [2/2]

octave::textscan::textscan ( const textscan &  )

delete

~textscan()

octave::textscan::~textscan ( void  )

default

Member Function Documentation

do_scan()

octave_value octave::textscan::do_scan ( std::istream &  isp, textscan_format_list &  fmt_list, octave_idx_type  ntimes  )

private

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

References cat_op(), error(), m_buffer_size, m_collect_output, m_comment_len, m_delim_len, m_delim_table, m_delims, m_eol1, m_eol2, m_header_lines, m_lines, m_return_on_error, m_treat_as_empty_len, m_whitespace, m_who, max(), min(), multiple_delims_as_one, octave::textscan_format_list::num_conversions(), octave::textscan_format_list::numel(), octave_value(), octave::textscan_format_list::out_buf(), ra_idx, octave::textscan_format_list::read_first_row(), read_format_once(), octave::textscan_format_list::set_from_first, and skip_delim().

Referenced by scan().

is_delim()

bool octave::textscan::is_delim ( unsigned char  ch ) const

inlineprivate

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

Referenced by read_format_once(), scan_string(), and skip_delim().

isspace()

bool octave::textscan::isspace ( unsigned int  ch ) const

inlineprivate

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

Referenced by parse_options(), skip_delim(), and skip_whitespace().

lookahead()

int octave::textscan::lookahead ( delimited_stream &  is, const Cell &  targets, int  max_len, bool  case_sensitive = true  ) const

private

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

References octave::delimited_stream::clear(), Array< T, Alloc >::numel(), octave_strncasecmp(), octave::delimited_stream::read(), octave::delimited_stream::seekg(), octave::string::strncmp(), and octave::delimited_stream::tellg().

Referenced by read_double(), read_format_once(), and skip_delim().

match_literal()

bool octave::textscan::match_literal ( delimited_stream &  isp, const textscan_format_elt &  elem  )

private

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

References octave::delimited_stream::get_undelim(), octave::delimited_stream::putback(), octave::delimited_stream::setstate(), skip_whitespace(), octave::textscan_format_elt::text, and octave::textscan_format_elt::width.

Referenced by read_format_once().

operator=()

textscan & octave::textscan::operator= ( const textscan &  )

delete

parse_options()

void octave::textscan::parse_options ( const octave_value_list &  args, textscan_format_list &  fmt_list  )

private

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

References octave_value_list::cell_value(), do_string_escapes(), error(), octave::textscan_format_list::has_string, isspace(), len, octave_value_list::length(), m_buffer_size, m_collect_output, m_comment_char, m_comment_len, m_comment_style, m_default_exp, m_delim_len, m_delim_list, m_delim_table, m_delims, m_empty_value, m_eol1, m_eol2, m_exp_chars, m_header_lines, m_return_on_error, m_treat_as_empty, m_treat_as_empty_len, m_whitespace, m_whitespace_table, m_who, max(), multiple_delims_as_one, Array< T, Alloc >::numel(), Array< T, Alloc >::size(), and transform().

Referenced by scan().

read_double()

double octave::textscan::read_double ( delimited_stream &  is, const textscan_format_elt &  fmt  ) const

private

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

References octave::delimited_stream::clear(), octave::delimited_stream::get(), Inf, lookahead(), m_exp_chars, m_inf_nan, NaN, octave::delimited_stream::peek(), octave::pown(), octave::textscan_format_elt::prec, octave::delimited_stream::putback(), octave::delimited_stream::rdstate(), octave::delimited_stream::setstate(), and octave::textscan_format_elt::width.

Referenced by scan_complex(), and scan_one().

read_format_once()

int octave::textscan::read_format_once ( delimited_stream &  isp, textscan_format_list &  fmt_list, std::list< octave_value > &  retval, Array< octave_idx_type >  row, int &  done_after  )

private

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

References octave::delimited_stream::clear(), elem, octave::delimited_stream::eof(), error(), octave::delimited_stream::fail(), octave::textscan_format_list::first(), is_delim(), Array< T, Alloc >::isempty(), octave::textscan_format_elt::literal_conversion, lookahead(), m_delim_len, m_delim_list, m_who, match_literal(), octave::textscan_format_list::next(), octave::textscan_format_list::numel(), octave::delimited_stream::peek(), octave::delimited_stream::rdstate(), scan_one(), octave::delimited_stream::seekg(), octave::delimited_stream::setstate(), skip_delim(), octave::delimited_stream::tellg(), and warning().

Referenced by do_scan().

read_until()

std::string octave::textscan::read_until ( delimited_stream &  is, const Cell &  delimiters, const std::string &  ends  ) const

private

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

References octave::delimited_stream::eof(), octave::delimited_stream::get_undelim(), m_eol1, m_eol2, octave::next, Array< T, Alloc >::numel(), octave::delimited_stream::putback(), and scan_caret().

Referenced by scan_string().

scan()

octave_value octave::textscan::scan	(	std::istream &	isp,
		const std::string &	fmt,
		octave_idx_type	ntimes,
		const octave_value_list &	options,
		octave_idx_type &	read_count
	)

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

References do_scan(), parse_options(), and octave::state.

scan_bracket()

int octave::textscan::scan_bracket ( delimited_stream &  is, const std::string &  pattern, std::string &  val  ) const

private

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

References octave::delimited_stream::get_undelim(), and octave::delimited_stream::putback().

Referenced by scan_one().

scan_caret()

int octave::textscan::scan_caret ( delimited_stream &  is, const std::string &  pattern, std::string &  val  ) const

private

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

References octave::delimited_stream::eof(), octave::delimited_stream::get_undelim(), and octave::delimited_stream::putback().

Referenced by read_until(), scan_one(), scan_qstring(), and skip_whitespace().

scan_complex()

void octave::textscan::scan_complex ( delimited_stream &  is, const textscan_format_elt &  fmt, Complex &  val  ) const

private

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

References octave::delimited_stream::clear(), octave::delimited_stream::eof(), octave::delimited_stream::fail(), octave::delimited_stream::get(), Inf, octave::math::is_NaN_or_NA(), m_empty_value, m_treat_as_empty, m_treat_as_empty_len, Array< T, Alloc >::numel(), octave::delimited_stream::peek(), octave::delimited_stream::putback(), octave::delimited_stream::rdstate(), octave::delimited_stream::read(), read_double(), octave_value::scalar_value(), octave::delimited_stream::seekg(), octave::state, octave::string::strncmp(), and octave::delimited_stream::tellg().

Referenced by octave::textscan_format_list::read_first_row(), and scan_one().

scan_cstring()

void octave::textscan::scan_cstring ( delimited_stream &  is, const textscan_format_elt &  fmt, std::string &  val  ) const

private

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

References octave::delimited_stream::get_undelim(), m_encoding, octave::string::u8_from_encoding(), and octave::textscan_format_elt::width.

Referenced by scan_one().

scan_one()

void octave::textscan::scan_one ( delimited_stream &  is, const textscan_format_elt &  fmt, octave_value &  ov, Array< octave_idx_type >  row  )

private

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

References octave::textscan_format_elt::bitwidth, cat_op(), octave::textscan_format_elt::char_class, octave::delimited_stream::clear(), octave::textscan_format_elt::discard, octave::delimited_stream::fail(), octave_base_value::fast_elem_insert(), octave::delimited_stream::field_done(), octave_value::internal_rep(), octave_value::isreal(), m_empty_value, octave::textscan_format_elt::numeric, octave::delimited_stream::rdstate(), read_double(), scan_bracket(), scan_caret(), scan_complex(), scan_cstring(), scan_qstring(), scan_string(), skip_whitespace(), and octave::textscan_format_elt::type.

Referenced by read_format_once().

scan_qstring()

void octave::textscan::scan_qstring ( delimited_stream &  is, const textscan_format_elt &  fmt, std::string &  val  )

private

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

References octave::delimited_stream::get(), octave::delimited_stream::get_undelim(), m_encoding, octave::delimited_stream::peek(), octave::delimited_stream::peek_undelim(), scan_caret(), scan_string(), skip_whitespace(), and octave::string::u8_from_encoding().

Referenced by scan_one().

scan_string()

void octave::textscan::scan_string ( delimited_stream &  is, const textscan_format_elt &  fmt, std::string &  val  ) const

private

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

References octave::delimited_stream::get(), is_delim(), Array< T, Alloc >::isempty(), m_delim_list, m_encoding, m_eol1, m_eol2, max(), Array< T, Alloc >::numel(), octave::delimited_stream::putback(), read_until(), octave::string::u8_from_encoding(), and octave::textscan_format_elt::width.

Referenced by scan_one(), and scan_qstring().

skip_delim()

int octave::textscan::skip_delim ( delimited_stream &  is )

private

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

References octave::delimited_stream::get(), octave::delimited_stream::get_undelim(), is_delim(), isspace(), lookahead(), m_delim_len, m_delim_list, m_eol1, m_eol2, m_lines, multiple_delims_as_one, Array< T, Alloc >::numel(), octave::delimited_stream::peek_undelim(), octave::delimited_stream::putback(), and skip_whitespace().

Referenced by do_scan(), octave::textscan_format_list::read_first_row(), and read_format_once().

skip_whitespace()

int octave::textscan::skip_whitespace ( delimited_stream &  is, bool  EOLstop = true  )

private

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

References octave::delimited_stream::clear(), octave::delimited_stream::eof(), octave::delimited_stream::get_undelim(), isspace(), m_comment_char, m_comment_len, m_comment_style, m_eol1, m_eol2, m_lines, Array< T, Alloc >::numel(), octave::delimited_stream::peek_undelim(), octave::delimited_stream::putback(), octave::delimited_stream::rdstate(), octave::delimited_stream::read(), scan_caret(), octave::delimited_stream::seekg(), octave::state, octave::string::strncmp(), and octave::delimited_stream::tellg().

Referenced by match_literal(), octave::textscan_format_list::read_first_row(), scan_one(), scan_qstring(), and skip_delim().

whitespace_delim()

bool octave::textscan::whitespace_delim ( void  ) const

inlineprivate

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

Friends And Related Function Documentation

textscan_format_list

friend class textscan_format_list

friend

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

Member Data Documentation

m_buf

std::string octave::textscan::m_buf

private

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

m_buffer_size

octave_idx_type octave::textscan::m_buffer_size

private

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

Referenced by do_scan(), and parse_options().

m_collect_output

bool octave::textscan::m_collect_output

private

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

Referenced by do_scan(), and parse_options().

m_comment_char

int octave::textscan::m_comment_char

private

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

Referenced by parse_options(), and skip_whitespace().

m_comment_len

int octave::textscan::m_comment_len

private

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

Referenced by do_scan(), parse_options(), and skip_whitespace().

m_comment_style

Cell octave::textscan::m_comment_style

private

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

Referenced by parse_options(), and skip_whitespace().

m_date_locale

std::string octave::textscan::m_date_locale

private

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

m_default_exp

bool octave::textscan::m_default_exp

private

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

Referenced by parse_options().

m_delim_len

int octave::textscan::m_delim_len

private

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

Referenced by do_scan(), parse_options(), read_format_once(), and skip_delim().

m_delim_list

Cell octave::textscan::m_delim_list

private

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

Referenced by parse_options(), read_format_once(), scan_string(), and skip_delim().

m_delim_table

std::string octave::textscan::m_delim_table

private

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

Referenced by do_scan(), and parse_options().

m_delims

std::string octave::textscan::m_delims

private

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

Referenced by do_scan(), and parse_options().

m_empty_value

octave_value octave::textscan::m_empty_value

private

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

Referenced by parse_options(), octave::textscan_format_list::read_first_row(), scan_complex(), and scan_one().

m_encoding

std::string octave::textscan::m_encoding

private

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

Referenced by scan_cstring(), scan_qstring(), and scan_string().

m_eol1

short octave::textscan::m_eol1

private

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

Referenced by do_scan(), parse_options(), octave::textscan_format_list::read_first_row(), read_until(), scan_string(), skip_delim(), and skip_whitespace().

m_eol2

short octave::textscan::m_eol2

private

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

Referenced by do_scan(), parse_options(), octave::textscan_format_list::read_first_row(), read_until(), scan_string(), skip_delim(), and skip_whitespace().

m_exp_chars

std::string octave::textscan::m_exp_chars

private

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

Referenced by parse_options(), and read_double().

m_header_lines

int octave::textscan::m_header_lines

private

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

Referenced by do_scan(), and parse_options().

m_inf_nan

Cell octave::textscan::m_inf_nan

private

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

Referenced by read_double().

m_lines

octave_idx_type octave::textscan::m_lines

private

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

Referenced by do_scan(), skip_delim(), and skip_whitespace().

m_return_on_error

short octave::textscan::m_return_on_error

private

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

Referenced by do_scan(), and parse_options().

m_treat_as_empty

Cell octave::textscan::m_treat_as_empty

private

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

Referenced by parse_options(), and scan_complex().

m_treat_as_empty_len

int octave::textscan::m_treat_as_empty_len

private

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

Referenced by do_scan(), parse_options(), and scan_complex().

m_whitespace

std::string octave::textscan::m_whitespace

private

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

Referenced by do_scan(), and parse_options().

m_whitespace_table

std::string octave::textscan::m_whitespace_table

private

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

Referenced by parse_options().

m_who

std::string octave::textscan::m_who

private

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

Referenced by do_scan(), parse_options(), and read_format_once().

multiple_delims_as_one

bool octave::textscan::multiple_delims_as_one

private

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

Referenced by do_scan(), parse_options(), and skip_delim().

---

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

• libinterp/corefcn/oct-stream.cc