SourcePro® 2024.1 |
SourcePro® API Reference Guide |
Converts text from UTF-16 to various byte-oriented standard character encoding schemes. More...
#include <rw/i18n/RWUFromUnicodeConverter.h>
Classes | |
class | ErrorResponseState |
Stores the current error response state of an RWUFromUnicodeConverter converter. More... | |
Public Types | |
enum | ErrorResponseType { Stop , Skip , Substitute , EscapeNativeHexadecimal , EscapeJavaHexadecimal , EscapeCHexadecimal , EscapeXmlDecimal , EscapeXmlHexadecimal } |
Public Member Functions | |
RWUFromUnicodeConverter (const char *encoding) | |
RWUFromUnicodeConverter (const RWUConverterBase &original) | |
RWUFromUnicodeConverter (const RWUFromUnicodeConverter &original) | |
~RWUFromUnicodeConverter () | |
void | convert (const RWUChar16 *source, RWCString &target, bool flush=true) |
void | convert (const RWUChar16 *source, std::string &target, bool flush=true) |
void | convert (const RWUChar16 source[], int32_t size, RWCString &target, bool flush=true) |
void | convert (const RWUChar16 source[], int32_t size, std::string &target, bool flush=true) |
void | convert (const RWUString &source, RWCString &target, bool flush=true) |
void | convert (const RWUString &source, std::string &target, bool flush=true) |
RWCString | getSubstitutionSequence () const |
RWUFromUnicodeConverter & | operator= (const RWUConverterBase &rhs) |
RWUFromUnicodeConverter & | operator= (const RWUFromUnicodeConverter &rhs) |
void | reset () |
void | restoreErrorResponseState (const ErrorResponseState &state) |
ErrorResponseState | saveErrorResponseState () const |
void | setErrorResponse (ErrorResponseType response) |
void | setSubstitutionSequence (const char substitutionSequence[], size_t length) |
Public Member Functions inherited from RWUConverterBase | |
~RWUConverterBase () | |
RWCString | getCanonicalName () const |
void | getLocalizedName (const RWULocale &locale, RWUString &result) const |
size_t | getMaxBytesPerChar () const |
size_t | getMinBytesPerChar () const |
bool | operator!= (const RWUConverterBase &rhs) const |
bool | operator== (const RWUConverterBase &rhs) const |
Additional Inherited Members | |
Static Public Member Functions inherited from RWUConverterBase | |
static RWCString | getCurrentLocaleEncodingName () |
static RWCString | getDefaultEncodingName () |
static void | setDefaultEncodingName (const char *encoding) |
Protected Member Functions inherited from RWUConverterBase | |
RWUConverterBase (const char *encoding) | |
RWUConverterBase (const RWUConverterBase &original) | |
RWUConverterBase & | operator= (const RWUConverterBase &rhs) |
RWUFromUnicodeConverter provides a unidirectional text conversion facility for translating from UTF-16 to various byte-oriented standard character encoding schemes.
The convert() method appends the results of a conversion to a target buffer. If its flush
argument is true
, convert() flushes its internal buffers to the target buffer and clears its internal state. For modal encodings such as ISO-2022, clearing the internal state ensures that the next call to convert() produces target text that begins in the target encoding's default, unshifted state.
Calling convert() once with a value of true
for flush
is useful when converting a piece of text in its entirety from UTF-16 to a target encoding. In contrast, convert() may be used to fill a target buffer in a piecemeal fashion. Repeatedly calling convert() with a value of false
for flush
, then calling it once with a value of true
, causes convert() to flush its buffers and clear its internal state only at the end of a multi-invocation conversion process.
At the conclusion of a successful call to convert() with flush
set to true
, the converter is reset automatically to a default, initial state, ready to start a new conversion process. Sometimes, however, it may be necessary to reset a converter explicitly using the reset() method:
Program output:
An ErrorResponseType value indicates what action an RWUFromUnicodeConverter should take when it encounters an error during the conversion process. Potential errors include code points with no mapping in the target encoding, and ill-formed code unit sequences, such as a low surrogate not followed by a high surrogate or a high surrogate without a preceding low surrogate. The default error response is RWUFromUnicodeConverter::Substitute.
Enumerator | |
---|---|
Stop | Stops the conversion process, and throws an RWUException. |
Skip | Silently skips over any illegal sequences, without writing to the target buffer. |
Substitute | Substitutes illegal sequences with the current substitution sequence. The default substitution sequence depends on the target encoding. For US-ASCII-based encodings, the default substitution sequence is |
EscapeNativeHexadecimal | Replaces illegal sequences with a
|
EscapeJavaHexadecimal | Replaces illegal sequences with a
|
EscapeCHexadecimal | Replaces illegal sequences with a
|
EscapeXmlDecimal | Replaces illegal sequences with a
|
EscapeXmlHexadecimal | Replaces illegal sequences with a
|
|
inline |
Constructs an RWUFromUnicodeConverter for the character encoding scheme given by encoding, the US-ASCII name or alias of a character encoding scheme (see RWUAvailableEncodingList and RWUEncodingAliasList).
RWUException | Thrown to indicate that the converter could not be constructed. The exception carries one of the following status codes: |
|
inline |
Constructs a converter that is a deep copy of another converter. The new converter uses the same character encoding scheme as the original converter, and possesses the same internal state as the original converter.
Exercise care when copying converters, especially those used for stateful or multibyte encodings. The new converter may be initialized in a state that causes the converter to produce errors if used to convert a new chunk of text. Consider using reset() to restore the converter to a known default state before use.
RWUException | Thrown to indicate that the copy could not be completed because memory could not be allocated for the underlying implementation object. |
|
inline |
Constructs a converter that is a deep copy of another converter. The new converter uses the same character encoding scheme as the original converter, and possesses the same internal state as the original converter.
Exercise care when copying converters, especially those used for stateful or multibyte encodings. The new converter may be initialized in a state that causes the converter to produce errors if used to convert a new chunk of text. Consider using reset() to restore the converter to a known default state before use.
RWUException | Thrown to indicate that the copy could not be completed because memory could not be allocated for the underlying implementation object. |
|
inline |
Destructor.
void RWUFromUnicodeConverter::convert | ( | const RWUChar16 * | source, |
RWCString & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the null-terminated source array into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target RWCString.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
void RWUFromUnicodeConverter::convert | ( | const RWUChar16 * | source, |
std::string & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the null-terminated source array into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target string.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
void RWUFromUnicodeConverter::convert | ( | const RWUChar16 | source[], |
int32_t | size, | ||
RWCString & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the sized source array into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target RWCString. size specifies number of the code units contained in the array. The array may contain embedded nulls.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
void RWUFromUnicodeConverter::convert | ( | const RWUChar16 | source[], |
int32_t | size, | ||
std::string & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the sized source array into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target string. size specifies number of the code units contained in the array. The array may contain embedded nulls.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
void RWUFromUnicodeConverter::convert | ( | const RWUString & | source, |
RWCString & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the given RWUString into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target RWCString.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
void RWUFromUnicodeConverter::convert | ( | const RWUString & | source, |
std::string & | target, | ||
bool | flush = true ) |
Converts the sequence of UTF-16 code units contained in the given RWUString into the sequence of bytes required to represent the source in the target character encoding scheme and appends that sequence of bytes to the target string.
The boolean value flush specifies whether self should be flushed to ensure that any code units stored in the converter's internal state are written to target. The default (true
) value explicitly forces a flush and resets the converter to the known default state. This value must be set to true
when the current source buffer is the last available chunk of source.
You must also be sure that the source string encodes complete characters, if the output may be flushed, as any saved state and characters would be lost.
RWUException | Thrown if an unhandled conversion error occurs. The target is not modified if an exception is thrown. |
RWCString RWUFromUnicodeConverter::getSubstitutionSequence | ( | ) | const |
Returns the current sequence of bytes that self inserts into the conversion target when a source character or sequence is encountered that cannot be represented in the target encoding.
|
inline |
Assignment operator. Makes self a deep copy of rhs. Self uses the same character encoding scheme as rhs, and possesses the same internal state as rhs.
Exercise care when copying converters, especially those used for stateful or multibyte encodings. The new converter may be initialized in a state that causes the converter to produce errors if used to convert a new chunk of text. Consider using reset() to restore the converter to a known state before use.
RWUException | Thrown to indicate that the copy could not be completed because memory could not be allocated for the underlying implementation object. |
|
inline |
Assignment operator. Makes self a deep copy of rhs. Self uses the same character encoding scheme as rhs, and possesses the same internal state as rhs.
Exercise care when copying converters, especially those used for stateful or multibyte encodings. The new converter may be initialized in a state that causes the converter to produce errors if used to convert a new chunk of text. Consider using reset() to restore the converter to a known state before use.
RWUException | Thrown to indicate that the copy could not be completed because memory could not be allocated for the underlying implementation object. |
|
inline |
Resets self by clearing the internal buffers and restoring the state to a known default state.
|
inline |
Restores the error handling state of the converter from a saved copy. This is the only means of restoring an error response state that existed prior to a call to setErrorResponse(). Use saveErrorResponseState() to save the error response state.
|
inline |
Saves the current error handling state of the converter. This is the only means for saving the current error response state prior to calling setErrorResponse(). Use restoreErrorResponseState() to restore the saved state.
void RWUFromUnicodeConverter::setErrorResponse | ( | ErrorResponseType | response | ) |
Specifies the action self should take when it encounters an error during the conversion process.
void RWUFromUnicodeConverter::setSubstitutionSequence | ( | const char | substitutionSequence[], |
size_t | length ) |
Specifies the sequence of bytes that self should insert into the conversion target when a source character or sequence is encountered that cannot be represented in the target encoding.
Many encodings have predefined substitution sequences. For example, the single character value 0x1A
is commonly used for most US-ASCII-based encodings.
A valid substitutionSequence must be an array containing a sequence of 1
to 4
bytes. The length parameter specifies the length of the substitution sequence in bytes. The number of bytes must fall on or between the values returned by RWUConverterBase::getMinBytesPerChar()and RWUConverterBase::getMaxBytesPerChar().
RWUException | Thrown with a value RWUIndexOutOfBoundsError to indicate that the length of the substitution sequence is incompatible with the character size of the target encoding. |
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |