RWWCharInputStream Class Reference
[Streams]

Handle class for all the wide character input stream implementation classes. More...

#include <rw/stream/RWWCharInputStream.h>

Inheritance diagram for RWWCharInputStream:

List of all members.

Public Member Functions
	RWWCharInputStream (RWWCharInputStreamImp *ptr)
	RWWCharInputStream (const RWWCharInputStream &handle)
RWWCharInputStream &	operator= (const RWWCharInputStream &handle)
RWWCharInputStream &	operator>> (RWWCharInputStream &(*pf)(RWWCharInputStream &))
RWWCharInputStream	operator>> (RWWCharInputStream(*pf)(RWWCharInputStream &))
RWWCharInputStream &	operator>> (wchar_t &wcharValue)
wchar_t	read ()
RWSize	read (wchar_t *wcharArray, RWSize numWChars)
RWSize	readUntil (wchar_t *wcharArray, RWSize maxSize, wchar_t delim)
void	close ()
bool	isBad () const
bool	isFail () const
bool	isGood () const
bool	isEof () const
RWSize	available () const
RWSize	skip (RWSize numUnits)
Related Functions
(Note that these are not member functions.)
RWWCharInputStream &	rwDisc (RWWCharInputStream &stream)

---

Detailed Description

Handle class for all the wide character input stream implementation classes. Implements the handle idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

RWWCharInputStream::RWWCharInputStream

(

RWWCharInputStreamImp *

ptr

)

[inline, explicit]

Constructor.

RWWCharInputStream::RWWCharInputStream

(

const RWWCharInputStream &

handle

)

[inline]

Copy constructor.

Parameters:

handle

A wide character stream handle used to initialize the newly created handle.

---

Member Function Documentation

RWSize RWWCharInputStream::available

(

)

const [inline]

Returns the number of wide characters that can be read from the stream without blocking. Throws no exceptions.

void RWWCharInputStream::close

(

void

)

[inline]

Closes the stream.

bool RWWCharInputStream::isBad

(

)

const [inline]

Returns true to indicate a loss of integrity resulting from an input operation, such as an irrecoverable read error from a file. Throws no exceptions.

bool RWWCharInputStream::isEof

(

)

const [inline]

Returns true to indicate that an input operation reached the end of an input sequence. Throws no exceptions.

bool RWWCharInputStream::isFail

(

)

const [inline]

Returns true to indicate that an input operation failed to read the expected data. Throws no exceptions.

bool RWWCharInputStream::isGood

(

)

const [inline]

Returns true to indicate a stream in a valid state. Throws no exceptions.

RWWCharInputStream& RWWCharInputStream::operator=

(

const RWWCharInputStream &

handle

)

[inline]

Assignment operator. Throws no exceptions.

Parameters:

handle

A wide character stream handle used to initialize this handle.

RWWCharInputStream& RWWCharInputStream::operator>>

(

wchar_t &

wcharValue

)

[inline]

Reads a single wide character from the stream.

Parameters:

wcharValue

The wide character to be read from the stream.

RWWCharInputStream RWWCharInputStream::operator>>

(

RWWCharInputStream(*)(RWWCharInputStream &)

pf

)

[inline]

Extractor executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWWCharInputStream& RWWCharInputStream::operator>>

(

RWWCharInputStream &(*)(RWWCharInputStream &)

pf

)

[inline]

Extractor executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWSize RWWCharInputStream::read	(	wchar_t *	wcharArray,
		RWSize	numWChars
	)			[inline]

Reads an array of wide characters from the stream. The array must be pre-allocated to contain at least numWChars elements. The function returns the actual number of wide characters extracted from the stream.

Parameters:

	wcharArray	A pointer to the first element of the array.
	numWChars	The number of wide characters to be read from the stream.

wchar_t RWWCharInputStream::read

(

void

)

[inline]

Reads a single wide character from the stream.

RWSize RWWCharInputStream::readUntil	(	wchar_t *	wcharArray,
		RWSize	maxSize,
		wchar_t	delim
	)			[inline]

Reads wide characters from the stream until the last wide character read is equal to delim, or maxSize wide characters have been read, or the end of the input sequence is reached. The wide characters read are stored in wcharArray. The function returns the actual number of wide characters read from the stream.

Parameters:

	wcharArray	A pointer to the array receiving the wide characters extracted from the stream.
	maxSize	The maximum number of wide characters to be read.
	delim	The wide character used as a delimiter.

RWSize RWWCharInputStream::skip

(

RWSize

numUnits

)

[inline]

Skips numUnits wide characters from the input sequence if possible. The function returns the actual number of wide characters skipped, which can be any value between 0 and numUnits.

Parameters:

numUnits

The number of wide characters to be skipped.

---

Friends And Related Function Documentation

RWWCharInputStream & rwDisc

(

RWWCharInputStream &

stream

)

[related]

Manipulator that discards a narrow character from a stream input sequence.

Parameters:

stream

The wide character stream.