Package smjg.libs.util.console

Console input and output. More...

Classes
class	ConsoleInput
	The smjg.libs.util.console.ConsoleInput class is used to receive text from the standard input. More...
class	ConsoleOutput
	The smjg.libs.util.console.ConsoleOutput class used to write out text to the standard output and error streams. More...
class	ConsoleException
	The smjg.libs.util.console.ConsoleException class is an exception thrown when a console I/O operation fails. More...
Functions
int	isatty (int)
int	GetConsoleCP ()
int	GetConsoleOutputCP ()
HANDLE	GetStdHandle (uint)
BOOL	ReadConsoleW (HANDLE, LPVOID, DWORD, LPDWORD, LPVOID)
Variables
ConsoleInput	cIn
	The standard input stream.
ConsoleOutput	cOut
	The standard output stream.
ConsoleOutput	cErr
	The standard error stream.

---

Detailed Description

Console input and output.

The smjg.libs.util.console module provides a means of communicating with the standard input and output streams. It is designed to provide the following benefits over stream classes in Phobos:

• support Windows character sets
• fix a bug in Win9x whereby a line of output is lost on stdin EOF
• flag EOF of stdin immediately from the class user's point of view.

The application programmer would use this module by means of the cIn, cOut and cErr objects.

This is not intended to be a sophisticated text I/O library. The TextStream class in Indigo will provide something much more powerful when and if it is completed.

Any application that uses this module should use it consistently throughout if possible. This ensures that the EOF fix works correctly and prevents buffering conflicts between different I/O libraries/APIs.

Since:

0.03

Todo:

Implement error checking. (Not sure how much is needed.)

---

Function Documentation

int smjg.libs.util.console.GetConsoleCP

(

)

int smjg.libs.util.console.GetConsoleOutputCP

(

)

HANDLE smjg.libs.util.console.GetStdHandle

(

uint

)

int smjg.libs.util.console.isatty

(

int

)

BOOL smjg.libs.util.console.ReadConsoleW	(	HANDLE	,
		LPVOID	,
		DWORD	,
		LPDWORD	,
		LPVOID
	)

---

Variable Documentation

ConsoleOutput smjg::libs::util::console.cErr

The standard error stream.

ConsoleInput smjg::libs::util::console.cIn

The standard input stream.

ConsoleOutput smjg::libs::util::console.cOut

The standard output stream.

---