Cpl::Io::Stdio::StdIn Class Reference

This concrete class represents the C-library 'stdin' stream. More...

Detailed Description

This concrete class represents the C-library 'stdin' stream.

NOTE: Many instances of this class may be created - even though there is only ONE stdin. This is OK because all instance reference the systems/platform 'stdin'

NOTE: stdin under Windoze is problematic with how the available() method is implemented. See the win32/Input.cpp file for more details. There is partial work-around for the issue. It can be enabled be defining the following in colony_confi.h: USE_CPL_IO_STDIO_WIN32_STDIN_CONSOLE_HACK

#include <StdIn.h>

Inheritance diagram for Cpl::Io::Stdio::StdIn:

Collaboration diagram for Cpl::Io::Stdio::StdIn:

Public Member Functions
	StdIn ()
	Constructor.
void	close ()
	Overriding inherited behavior so as to NOT close the actual native stream.
Public Member Functions inherited from Cpl::Io::Stdio::Input_
	Input_ (int fd)
	Constructor.
	Input_ (void *handle)
	Constructor.
	Input_ (Cpl::Io::Descriptor streamfd)
	Constructor.
	Input_ (void)
	Constructor.
	~Input_ (void)
	Destructor.
void	activate (int fd)
	Activates and/or resets the underlying 'fd' for the stream.
void	activate (void *handle)
	Activates and/or resets the underlying 'handle' for the stream.
void	activate (Cpl::Io::Descriptor streamfd)
	Activates and/or resets the underlying 'streamfd' for the stream.
bool	isOpened ()
	This method returns true if the file was successfully open and/or is still opened (i.e.
bool	read (void *buffer, int numBytes, int &bytesRead)
	See Cpl::Io::Input.
bool	available ()
	See Cpl::Io::Input.
bool	isEos ()
	See Cpl::Io::IsEos.
Public Member Functions inherited from Cpl::Io::Input
virtual bool	read (char &c)
	Reads a single byte from the stream.
virtual bool	read (Cpl::Text::String &destString)
	Reads N bytes into the String's internal buffer.
virtual	~Input ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Io::Close
virtual	~Close ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.
Public Member Functions inherited from Cpl::Io::IsEos
virtual	~IsEos ()
	Lets the make the destructor virtual.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Attributes inherited from Cpl::Io::Stdio::Input_
Cpl::Io::Descriptor	m_inFd
	Stream Handle.
bool	m_inEos
	Cache end-of-stream status.

Constructor & Destructor Documentation

StdIn()

Cpl::Io::Stdio::StdIn::StdIn

(

)

Constructor.

Member Function Documentation

close()

void Cpl::Io::Stdio::StdIn::close ( )

virtual

Overriding inherited behavior so as to NOT close the actual native stream.

In general closing stdin/stdout/stderr is bad thing.

Reimplemented from Cpl::Io::Stdio::Input_.

---

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

• Cpl/Io/Stdio/StdIn.h