Class IConsole
Defined in File console.hpp
Class Documentation
-
class IConsole
Device for reading from standard output.
Device for reading from standard output. It creates a wrapper class around the stdout handle from cstdio to implement an ecl output device. Do not use this directly, it serves only as the device handle for the console stream classes.
One peculiarity of this device, is that it will strip newlines from the incoming input. This is a characteristic exclusive to the input console device because of its interactive nature with the user.
Public Functions
-
inline IConsole()
Default constructor.
-
inline virtual ~IConsole()
-
inline bool open()
Dummy handle to satisfy the input device concept.
For console devices this does nothing - the standard input is always open. It is just a dummy handle built to ensure the input device concept is satisfied.
- Returns:
bool : always returns true (it is always open).
-
long read(char &c)
Read a character from standard input.
Reads a single character from standard input.
- Parameters:
c – : character to read into from standard input.
- Throws:
StandardException – : throws if reading returned an error [debug mode only].
-
long read(char *s, const unsigned long &n)
Reads a character string from standard input.
Reads a character string from standard input.
- Parameters:
s – : character string to read into from standard input.
n – : the number of bytes to read.
- Throws:
StandardException – : throws if reading returned an error [debug mode only].
-
inline const Error &error() const
Returns the most recent error status.
Use this to check on the status of the object after a method has been called. Mostly this is here to serve as a graceful fallback for when exceptions are disabled.
- Returns:
-
inline IConsole()