mootio::mstream Class Reference

Abstract base class for I/O stream wrappers. More...

Inheritance diagram for mootio::mstream:

Public Member Functions
Constructors etc.
	mstream (const std::string &myname="")
virtual	~mstream (void)
Integrity Tests
virtual bool	valid (void)
	operator bool (void)
virtual bool	eof (void)
virtual std::string	errmsg (void)
Open/Close
virtual bool	reopen (void)
virtual bool	close (void)

Public Attributes
std::string	name
	symbolic name of this stream More...

Detailed Description

This looks at first like a very ugly hack (which it admittedly is), since it reduces C++ iostreams to the low-level streambuf layer (which is all anyone ever really needs anyways), and wraps native C I/O calls in virtual methods (which are nasty icky OO and slow), so it gets us essentially the worst of both worlds. However:

• we get to keep printf()
• we get to use C++ streams, C FILE*s, zlib gzFile, and C in-memory buffers (via mootio::CBuffer) using one single class, which is just Too Darned Handy for extentible I/O methods.
• we get to keep printf()
• Support for file descriptors (sockets) should work in both the C and C++ idioms.
• we get to keep printf()
• native FILE* / char* / iostream maniuplation can still be done by the user by accessing the relevant underlying pointers directly.
• did I mention that we get to keep printf()?

Constructor & Destructor Documentation

mstream()

mootio::mstream::mstream ( const std::string &  myname = "" )

inline

Default constructor

~mstream()

virtual mootio::mstream::~mstream ( void  )

inlinevirtual

Destructor

Member Function Documentation

valid()

virtual bool mootio::mstream::valid ( void  )

inlinevirtual

Test stream integrity

Reimplemented in mootio::micbuffer, mootio::mcstream, mootio::mcxxstream< _StreamClass >, mootio::mcxxstream< std::istream >, mootio::mcxxstream< std::ostream >, and mootio::mzstream.

Referenced by moot::TokenWriterExpat::_put_sentence(), moot::TokenWriterExpat::_put_tokens(), errmsg(), moot::TokenReader::from_filename(), moot::TokenReader::opened(), moot::TokenWriter::opened(), operator bool(), moot::TokenWriter::to_filename(), and moot::TokenWriter::to_mstream().

operator bool()

mootio::mstream::operator bool ( void  )

inline

Alias for valid()

References valid().

eof()

virtual bool mootio::mstream::eof ( void  )

inlinevirtual

Test for eof

Reimplemented in mootio::micbuffer, mootio::mzstream, mootio::mcstream, mootio::mcxxstream< _StreamClass >, mootio::mcxxstream< std::istream >, and mootio::mcxxstream< std::ostream >.

errmsg()

virtual std::string mootio::mstream::errmsg ( void  )

inlinevirtual

Get current error message, if any

Reimplemented in mootio::mzstream, and mootio::mcstream.

References valid().

reopen()

virtual bool mootio::mstream::reopen ( void  )

inlinevirtual

(Re-)open currently selected stream

Reimplemented in mootio::mzfstream, mootio::mfstream, mootio::mzstream, and mootio::mcstream.

close()

virtual bool mootio::mstream::close ( void  )

inlinevirtual

Close currently selected stream

Reimplemented in mootio::mzfstream, mootio::mfstream, mootio::mzstream, and mootio::mcstream.

Referenced by moot::TokenReader::close(), moot::TokenWriter::close(), moot::mootExpatParser::from_fd(), and moot::mootExpatParser::from_string().

Member Data Documentation

name

std::string mootio::mstream::name

Referenced by mootio::mfstream::open(), mootio::mzfstream::open(), mootio::mfstream::reopen(), and mootio::mzfstream::reopen().

---

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

• mootIO.h