orstream: Input stream wrapper abstract base class More...

#include <irstream.hh>

Public Member Functions
virtual	~irstream ()
	Destructor. More...

virtual	operator bool () const =0
	bool conversion More...

virtual	operator std::istream const & () const =0
	Stream conversion. More...

virtual	operator std::istream & ()=0
	Stream conversion. More...

template<typename T >
irstream &	operator>> (T &t)
	Stream input. More...

virtual std::istream &	operator>> (std_manipulator m)=0
	Stream manipulator input. More...

virtual void	clear ()=0
	Clear the stream. More...

virtual void	seek_beg ()=0
	Seek to the beginning. More...

virtual int	get ()=0
	Get the next character. More...

virtual irstream &	get (char &c)=0
	Get the next character. More...

virtual irstream &	get (char *str, std::streamsize const count)=0
	Get the next specified number of characters. More...

virtual irstream &	get (char *str, std::streamsize const count, char const delim)=0
	Get the next specified number of characters. More...

virtual irstream &	get (std::string &str, std::streamsize const count)=0
	Get the next specified number of characters. More...

virtual irstream &	get (std::string &str, std::streamsize const count, char const delim)=0
	Get the next specified number of characters. More...

virtual irstream &	getline (char *line, std::streamsize const count)=0
	Get the rest of the line. More...

virtual irstream &	getline (char *line, std::streamsize const count, char const delim)=0
	Get the rest of the line. More...

virtual irstream &	getline (std::string &line)=0
	Get the rest of the line. More...

virtual irstream &	getline (std::string &line, char const delim)=0
	Get the rest of the line. More...

virtual irstream &	read (char *str, std::streamsize const count)=0
	Read the next specified number of characters. More...

virtual irstream &	read (std::string &str, std::streamsize const count)=0
	Read the next specified number of characters. More...

virtual std::streamsize	readsome (char *str, std::streamsize const count)=0
	Read the next available specified number of characters. More...

virtual std::streamsize	readsome (std::string &str, std::streamsize const count)=0
	Read the next available specified number of characters. More...

virtual irstream &	ignore ()=0
	Skip over the next character. More...

virtual irstream &	ignore (std::streamsize const count)=0
	Skip over the next specified number of characters. More...

virtual irstream &	ignore (std::streamsize const count, char const delim)=0
	Skip over the next specified number of characters. More...

virtual int	peek ()=0
	Returns the next character without extracting it. More...

virtual irstream &	unget ()=0
	Put the last character read back into the stream. More...

virtual irstream &	putback (char c)=0
	Put the last character read back into the stream and check that passed character is correct. More...

virtual std::istream const &	operator() () const =0
	Stream access. More...

virtual std::istream &	operator() ()=0
	Stream access. More...

virtual std::istream const &	stream () const =0
	Stream access. More...

virtual std::istream &	stream ()=0
	Stream access. More...

virtual std::streambuf *	rdbuf () const =0
	Pointer to the stream buffer. More...

virtual bool	good () const =0
	Good? More...

virtual bool	eof () const =0
	End of file? More...

virtual bool	fail () const =0
	Fail? More...

virtual bool	bad () const =0
	Bad? More...

virtual bool	compressed () const =0
	Compressed? More...

virtual bool	uncompressed () const =0
	Uncompressed? More...

virtual bool	gzipped () const =0
	gzipped? More...

Protected Types
typedef std::istream &(*	std_manipulator )(std::istream &)

Protected Member Functions
	irstream ()
	Default constructor. More...

Private Member Functions
	irstream (irstream const &)
	Copy constructor: Undefined. More...

irstream &	operator= (irstream const &)
	Copy assignment: Undefined. More...

Detailed Description

orstream: Input stream wrapper abstract base class

Member Typedef Documentation

typedef std::istream&(* utility::io::irstream::std_manipulator)(std::istream &)

protected

Constructor & Destructor Documentation

virtual utility::io::irstream::~irstream ( )

inlinevirtual

Destructor.

utility::io::irstream::irstream ( )

inlineprotected

Default constructor.

utility::io::irstream::irstream ( irstream const & )

private

Copy constructor: Undefined.

Member Function Documentation

virtual bool utility::io::irstream::bad ( ) const

pure virtual

Bad?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual void utility::io::irstream::clear ( )

pure virtual

Clear the stream.

Implemented in utility::io::icstream, and utility::io::izstream.

virtual bool utility::io::irstream::compressed ( ) const

pure virtual

Compressed?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual bool utility::io::irstream::eof ( ) const

pure virtual

End of file?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual bool utility::io::irstream::fail ( ) const

pure virtual

Fail?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual int utility::io::irstream::get ( )

pure virtual

Get the next character.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::get ( char & c )

pure virtual

Get the next character.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::get	(	char *	str,
		std::streamsize const	count
	)

pure virtual

Get the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::get	(	char *	str,
		std::streamsize const	count,
		char const	delim
	)

pure virtual

Get the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::get	(	std::string &	str,
		std::streamsize const	count
	)

pure virtual

Get the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::get	(	std::string &	str,
		std::streamsize const	count,
		char const	delim
	)

pure virtual

Get the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::getline	(	char *	line,
		std::streamsize const	count
	)

pure virtual

Get the rest of the line.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::getline	(	char *	line,
		std::streamsize const	count,
		char const	delim
	)

pure virtual

Get the rest of the line.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::getline ( std::string & line )

pure virtual

Get the rest of the line.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::getline	(	std::string &	line,
		char const	delim
	)

pure virtual

Get the rest of the line.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual bool utility::io::irstream::good ( ) const

pure virtual

Good?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual bool utility::io::irstream::gzipped ( ) const

pure virtual

gzipped?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::ignore ( )

pure virtual

Skip over the next character.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::ignore ( std::streamsize const count )

pure virtual

Skip over the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::ignore	(	std::streamsize const	count,
		char const	delim
	)

pure virtual

Skip over the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual utility::io::irstream::operator bool ( ) const

pure virtual

bool conversion

Implemented in utility::io::izstream, and utility::io::icstream.

virtual utility::io::irstream::operator std::istream & ( )

pure virtual

Stream conversion.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual utility::io::irstream::operator std::istream const & ( ) const

pure virtual

Stream conversion.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::istream const& utility::io::irstream::operator() ( ) const

pure virtual

Stream access.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::istream& utility::io::irstream::operator() ( )

pure virtual

Stream access.

Implemented in utility::io::izstream, and utility::io::icstream.

irstream& utility::io::irstream::operator= ( irstream const & )

private

Copy assignment: Undefined.

template<typename T >

irstream& utility::io::irstream::operator>> ( T & t )

inline

Stream input.

References stream().

virtual std::istream& utility::io::irstream::operator>> ( std_manipulator m )

pure virtual

Stream manipulator input.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual int utility::io::irstream::peek ( )

pure virtual

Returns the next character without extracting it.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::putback ( char c )

pure virtual

Put the last character read back into the stream and check that passed character is correct.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::streambuf* utility::io::irstream::rdbuf ( ) const

pure virtual

Pointer to the stream buffer.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::read	(	char *	str,
		std::streamsize const	count
	)

pure virtual

Read the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::read	(	std::string &	str,
		std::streamsize const	count
	)

pure virtual

Read the next specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::streamsize utility::io::irstream::readsome	(	char *	str,
		std::streamsize const	count
	)

pure virtual

Read the next available specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::streamsize utility::io::irstream::readsome	(	std::string &	str,
		std::streamsize const	count
	)

pure virtual

Read the next available specified number of characters.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual void utility::io::irstream::seek_beg ( )

pure virtual

Seek to the beginning.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual std::istream const& utility::io::irstream::stream ( ) const

pure virtual

Stream access.

Implemented in utility::io::izstream, and utility::io::icstream.

Referenced by operator>>().

virtual std::istream& utility::io::irstream::stream ( )

pure virtual

Stream access.

Implemented in utility::io::izstream, and utility::io::icstream.

virtual bool utility::io::irstream::uncompressed ( ) const

pure virtual

Uncompressed?

Implemented in utility::io::izstream, and utility::io::icstream.

virtual irstream& utility::io::irstream::unget ( )

pure virtual

Put the last character read back into the stream.

Implemented in utility::io::izstream, and utility::io::icstream.

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

src/utility/io/irstream.hh

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation