RWUCharFromUTF8ByteInputStreamImp

Module:  Advanced Tools   Package:  Streams

RWUCharFromUTF8ByteInputStreamImp  RWUCharInputStreamImp  
    RWInputStreamImp  RWStreamImp  RWBodyBase

• Local Index
• Header File
• Description
• Protected Constructor
• Public Destructor
• Static Public Member Function
• Public Member Functions
• Protected Member Functions

Members

available() close() getSourceStream() isBad()

isEof() isFail() isGood() make()

read() readUntil() RWUCharFromUTF8ByteInputStreamImp() skip()

~RWUCharFromUTF8ByteInputStreamImp()

#include <rw/stream/RWUCharFromUTF8ByteInputStreamImp.h>

Concrete class connecting a UTF-16 character stream to a UTF-8 binary stream. The bytes read from the UTF-8 binary stream used as the source of bytes are transformed into UTF-16 characters.

UTF-8 is a variable length encoding of the UTF-16 Standard using 8-bit sequences, where the high bits indicate which part of the sequence a byte belongs to. Implements the body idiom from the handle-body pattern.

RWUCharFromUTF8ByteInputStreamImp(RWByteInputStream&
                                  sourceStream);

Initializes the reference to the stream that will be used as the source of bytes.

Parameter List

sourceStream

The binary stream that will serve as the source of bytes.

virtual 
~RWUCharFromUTF8ByteInputStreamImp();

Destructor.

static RWUCharInputStream 
make(RWByteInputStream& source);

Constructs an RWUCharFromUTF8ByteInputStreamImp instance that uses source as the source of bytes, and returns a handle to it.

Parameter List

source

The binary stream that is used as the source of bytes.

virtual RWSize 
available() const;

Returns the minimum number of UTF-16 characters that can be read from the stream used as the source of bytes without blocking. The actual number might be greater than the number returned by this function.

virtual void 
close();

This function is forwarded to the binary stream used as the source of bytes. Throws no exceptions.

virtual bool 
isBad() const;

This function is forwarded to the binary stream used as the source of bytes. Throws no exceptions.

virtual bool 
isEof() const;

This function is forwarded to the binary stream used as the source of bytes. Throws no exceptions.

virtual bool 
isFail() const;

This function is forwarded to the binary stream used as the source of bytes. Throws no exceptions.

virtual bool 
isGood() const;

This function is forwarded to the binary stream used as the source of bytes. Throws no exceptions.

virtual RWUChar 
read();

Reads and decodes a single UTF-16 character from the stream used as the source of bytes.

virtual RWSize 
read(RWUChar* unicodeArray, RWSize numUChars);

Reads and decodes an array of UTF-16 characters from the stream used as the source of bytes. The array must be pre-allocated to contain at least numUChars elements. The function returns the actual number of UTF-16 characters extracted from the stream.

Parameter List

unicodeArray	A pointer to the first element of the array.
numUChars	The number of UTF-16 characters(s) to be read from the stream.

virtual RWSize 
readUntil(RWUChar* unicodeArray, RWSize maxSize, 
          RWUChar delim);

Reads and decodes UTF-16 characters from the stream used as the source of bytes until the last UTF-16 character read is equal to delim, or maxSize UTF-16 characters have been read, or the end of the input sequence is reached. The UTF-16 characters that are read are stored in unicodeArray. The function returns the actual number of UTF-16 characters inserted into unicodeArray. If the last character extracted is equal to delim, then it is not stored in unicodeArray.

Parameter List

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

virtual RWSize 
skip(RWSize numUnits);

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

Parameter List

numUnits

The number of UTF-16 characters to be skipped.

RWByteInputStream& 
getSourceStream();

const RWByteInputStream& 
getSourceStream() const;

These functions return a reference to the stream used as the source of bytes. They throw no exceptions.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.