Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions
nsIUnicodeDecoder Class Reference

Interface for a Converter from a Charset into Unicode. More...

#include <nsIUnicodeDecoder.h>

Inheritance diagram for nsIUnicodeDecoder:
Inheritance graph
[legend]
Collaboration diagram for nsIUnicodeDecoder:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { kOnError_Recover, kOnError_Signal }

Public Member Functions

NS_IMETHOD Convert (const char *aSrc, PRInt32 *aSrcLength, PRUnichar *aDest, PRInt32 *aDestLength)=0
 Converts the data from one Charset to Unicode.
NS_IMETHOD GetMaxLength (const char *aSrc, PRInt32 aSrcLength, PRInt32 *aDestLength)=0
 Returns a quick estimation of the size of the buffer needed to hold the converted data.
NS_IMETHOD Reset ()=0
 Resets the charset converter so it may be recycled for a completely different and urelated buffer of data.

Detailed Description

Interface for a Converter from a Charset into Unicode.

23/Nov/1998

Author:
Catalin Rotaru [CATA]

Definition at line 93 of file nsIUnicodeDecoder.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
kOnError_Recover 
kOnError_Signal 

Definition at line 98 of file nsIUnicodeDecoder.h.

       {
    kOnError_Recover,       // on an error, recover and continue
    kOnError_Signal         // on an error, stop and signal
  };

Member Function Documentation

NS_IMETHOD nsIUnicodeDecoder::Convert ( const char *  aSrc,
PRInt32 aSrcLength,
PRUnichar aDest,
PRInt32 aDestLength 
) [pure virtual]

Converts the data from one Charset to Unicode.

About the byte ordering:

  • For input, if the converter cares (that depends of the charset, for example a singlebyte will ignore the byte ordering) it should assume network order. If necessary and requested, we can add a method SetInputByteOrder() so that the reverse order can be used, too. That method would have as default the assumed network order.
  • The output stream is Unicode, having the byte order which is internal for the machine on which the converter is running on.

Unless there is not enough output space, this method must consume all the available input data! The eventual incomplete final character data will be stored internally in the converter and used when the method is called again for continuing the conversion. This way, the caller will not have to worry about managing incomplete input data by mergeing it with the next buffer.

Error conditions: If the read value does not belong to this character set, one should replace it with the Unicode special 0xFFFD. When an actual input error is encountered, like a format error, the converter stop and return error. Hoever, we should keep in mind that we need to be lax in decoding.

Converter required behavior: In this order: when output space is full - return right away. When input data is wrong, return input pointer right after the wrong byte. When partial input, it will be consumed and cached. All the time input pointer will show how much was actually consumed and how much was actually written.

Parameters:
aSrc[IN] the source data buffer
aSrcLength[IN/OUT] the length of source data buffer; after conversion will contain the number of bytes read
aDest[OUT] the destination data buffer
aDestLength[IN/OUT] the length of the destination data buffer; after conversion will contain the number of Unicode characters written
Returns:
NS_PARTIAL_MORE_INPUT if only a partial conversion was done; more input is needed to continue NS_PARTIAL_MORE_OUTPUT if only a partial conversion was done; more output space is needed to continue NS_ERROR_ILLEGAL_INPUT if an illegal input sequence was encountered and the behavior was set to "signal"

Implemented in nsOneByteDecoderSupport, nsBufferDecoderSupport, nsISO2022JPToUnicodeV2, nsUTF32LEToUnicode, nsUTF32BEToUnicode, nsEUCJPToUnicodeV2, WinCEUConvAdapter, nsUTF8ToUnicode, nsUTF16ToUnicode, nsUTF16LEToUnicode, nsUTF16BEToUnicode, nsISO2022CNToUnicode, nsShiftJISToUnicode, and nsISO2022KRToUnicode.

Here is the caller graph for this function:

NS_IMETHOD nsIUnicodeDecoder::GetMaxLength ( const char *  aSrc,
PRInt32  aSrcLength,
PRInt32 aDestLength 
) [pure virtual]

Returns a quick estimation of the size of the buffer needed to hold the converted data.

Remember: this estimation is >= with the actual size of the buffer needed. It will be computed for the "worst case"

Parameters:
aSrc[IN] the source data buffer
aSrcLength[IN] the length of source data buffer
aDestLength[OUT] the needed size of the destination buffer
Returns:
NS_EXACT_LENGTH if an exact length was computed NS_OK is all we have is an approximation

Implemented in nsOneByteDecoderSupport, nsBufferDecoderSupport, nsISO2022JPToUnicodeV2, nsEUCJPToUnicodeV2, WinCEUConvAdapter, nsUTF8ToUnicode, nsUTF32ToUnicode, nsISO2022CNToUnicode, nsShiftJISToUnicode, nsISO2022KRToUnicode, and nsUTF16ToUnicodeBase.

Here is the caller graph for this function:

Resets the charset converter so it may be recycled for a completely different and urelated buffer of data.

Implemented in nsOneByteDecoderSupport, nsBufferDecoderSupport, nsISO2022JPToUnicodeV2, nsEUCJPToUnicodeV2, WinCEUConvAdapter, nsUTF8ToUnicode, nsUTF16ToUnicode, nsBasicUTF7Decoder, nsUTF32ToUnicode, nsISO2022CNToUnicode, nsShiftJISToUnicode, nsISO2022KRToUnicode, and nsUTF16ToUnicodeBase.

Here is the caller graph for this function:


The documentation for this class was generated from the following file: