System::Text::ICUEncoding Class Reference

Inherits System::Text::Encoding.

Inherited by System::Text::ASCIIEncoding, System::Text::Latin1Encoding, System::Text::UnicodeEncoding, System::Text::UTF32Encoding, and System::Text::UTF8Encoding.

Public Member Functions

 ICUEncoding (const Details::EncodingInfoInternal *encoding_info)
 
ASPOSECPP_SHARED_API bool operator== (const ICUEncoding &other) const
 
ASPOSECPP_SHARED_API int GetByteCount (const char_t *chars, int count) override
 
ASPOSECPP_SHARED_API int GetBytes (const char_t *chars, int char_count, uint8_t *bytes, int byte_count) override
 
ASPOSECPP_SHARED_API int GetCharCount (const uint8_t *bytes, int count) override
 
ASPOSECPP_SHARED_API int GetChars (const uint8_t *bytes, int byte_count, char_t *chars, int char_count) override
 
ASPOSECPP_SHARED_API DecoderPtr GetDecoder () override
 
ASPOSECPP_SHARED_API EncoderPtr GetEncoder () override
 
ASPOSECPP_SHARED_API int GetMaxByteCount (int char_count) override
 
ASPOSECPP_SHARED_API int GetMaxCharCount (int byte_count) override
 
ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetPreamble () override
 
- Public Member Functions inherited from System::Text::Encoding
ASPOSECPP_SHARED_API bool Equals (SharedPtr< Object > obj) override
 
ASPOSECPP_SHARED_API int GetHashCode () const override
 
virtual ASPOSECPP_SHARED_API int get_CodePage ()
 
virtual ASPOSECPP_SHARED_API int get_WindowsCodePage ()
 
virtual ASPOSECPP_SHARED_API String get_WebName ()
 
virtual ASPOSECPP_SHARED_API String get_BodyName ()
 
virtual ASPOSECPP_SHARED_API String get_EncodingName ()
 
virtual ASPOSECPP_SHARED_API String get_HeaderName ()
 
virtual ASPOSECPP_SHARED_API bool get_IsSingleByte ()
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserDisplay ()
 
virtual ASPOSECPP_SHARED_API bool get_IsBrowserSave ()
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsDisplay ()
 
virtual ASPOSECPP_SHARED_API bool get_IsMailNewsSave ()
 
ASPOSECPP_SHARED_API bool get_IsReadOnly ()
 
ASPOSECPP_SHARED_API DecoderFallbackPtr get_DecoderFallback () const
 
ASPOSECPP_SHARED_API void set_DecoderFallback (const DecoderFallbackPtr value)
 
ASPOSECPP_SHARED_API const EncoderFallbackPtr get_EncoderFallback () const
 
ASPOSECPP_SHARED_API void set_EncoderFallback (const EncoderFallbackPtr value)
 
virtual ASPOSECPP_SHARED_API int GetByteCount (ArrayPtr< char_t > chars, int index, int count)
 
virtual ASPOSECPP_SHARED_API int GetByteCount (const String &s)
 
virtual ASPOSECPP_SHARED_API int GetByteCount (ArrayPtr< char_t > chars)
 
virtual ASPOSECPP_SHARED_API int GetBytes (ArrayPtr< char_t > chars, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
 
virtual ASPOSECPP_SHARED_API int GetBytes (const String &s, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (const String &s)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars, int index, int count)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars)
 
virtual ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes)
 
virtual ASPOSECPP_SHARED_API int GetChars (ArrayPtr< uint8_t > bytes, int byte_index, int byte_count, ArrayPtr< char_t > chars, int char_index)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual ASPOSECPP_SHARED_API ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes)
 
virtual ASPOSECPP_SHARED_API String GetString (uint8_t *bytes, int byte_count)
 
virtual ASPOSECPP_SHARED_API String GetString (ArrayPtr< uint8_t > bytes)
 
virtual ASPOSECPP_SHARED_API String GetString (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual ASPOSECPP_SHARED_API SharedPtr< ObjectClone ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Text::Encoding
typedef System::SharedPtr< EncodingPtr
 RTTI. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Text::Encoding
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes)
 
static ASPOSECPP_SHARED_API ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes, int index, int count)
 
static ASPOSECPP_SHARED_API EncodingPtr get_ASCII ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUnicode ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_Unicode ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF8Unmarked ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF32 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_BigEndianUTF32 ()
 
static ASPOSECPP_SHARED_API EncodingPtr get_UTF7 ()
 
static EncodingPtr get_Latin1 ()
 Gets Latin1 encoding. FOR INTERNAL USE. More...
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding (const String &name, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
static ASPOSECPP_SHARED_API EncodingPtr get_Default ()
 
static ASPOSECPP_SHARED_API ArrayPtr< EncodingInfoPtrGetEncodings ()
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Static Public Attributes inherited from System::Text::Encoding
static constexpr int DEFAULT_CODE_PAGE = 0
 Default codepage value. More...
 
- Protected Member Functions inherited from System::Text::Encoding
ASPOSECPP_SHARED_API Encoding ()
 Default constructor. More...
 
ASPOSECPP_SHARED_API Encoding (int codepage)
 
ASPOSECPP_SHARED_API Encoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
 Encoding (const Details::EncodingInfoInternal *info)
 
- Protected Attributes inherited from System::Text::Encoding
const Details::EncodingInfoInternal * m_info
 Pointer to internal encoding info. More...
 
const int m_codepage
 Code page identifier. More...
 
bool m_is_read_only = true
 Read-only flag. More...
 

Detailed Description

ICU-based encoding implementation. FOR INTERNAL USE. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ ICUEncoding()

System::Text::ICUEncoding::ICUEncoding ( const Details::EncodingInfoInternal *  encoding_info)

Constructor.

Parameters
encoding_infoEncoding internal info.

Member Function Documentation

◆ GetByteCount()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetByteCount ( const char_t *  chars,
int  count 
)
overridevirtual

Get the number of characters needed to encode a character buffer.

Parameters
charsCharacters buffer.
countBuffer size.
Returns
Required buffer size.

Reimplemented from System::Text::Encoding.

◆ GetBytes()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetBytes ( const char_t *  chars,
int  char_count,
uint8_t *  bytes,
int  byte_count 
)
overridevirtual

Get the bytes that result from encoding a character buffer.

Parameters
charsCharacters to encode.
char_countNumber of characters to convert.
bytesBuffer to put characters to.
byte_countOutput buffer size.
Returns
Number of written bytes.

Reimplemented from System::Text::Encoding.

◆ GetCharCount()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetCharCount ( const uint8_t *  bytes,
int  count 
)
overridevirtual

Get the number of characters needed to decode a byte buffer.

Parameters
bytesBytes to decode.
countBytes count.
Returns
Number of characters.

Reimplemented from System::Text::Encoding.

◆ GetChars()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetChars ( const uint8_t *  bytes,
int  byte_count,
char_t *  chars,
int  char_count 
)
overridevirtual

Get the characters that result from decoding a byte buffer.

Parameters
bytesBuffer to read bytes from.
byte_countInput buffer size.
charsBuffer to put characters to.
char_countOutput buffer size.
Returns
Number of written characters.

Reimplemented from System::Text::Encoding.

◆ GetDecoder()

ASPOSECPP_SHARED_API DecoderPtr System::Text::ICUEncoding::GetDecoder ( )
overridevirtual

Get a decoder that forwards requests to this object.

Returns
Newly created decoder.

Reimplemented from System::Text::Encoding.

◆ GetEncoder()

ASPOSECPP_SHARED_API EncoderPtr System::Text::ICUEncoding::GetEncoder ( )
overridevirtual

Get an encoder that forwards requests to this object.

Returns
Newly created encoder.

Reimplemented from System::Text::Encoding.

◆ GetMaxByteCount()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetMaxByteCount ( int  char_count)
overridevirtual

Get the maximum number of bytes needed to encode a specified number of characters.

Parameters
char_countNumber of characters to encode.
Returns
Number of bytes sufficient to encode any string of given character length.

Implements System::Text::Encoding.

Reimplemented in System::Text::UTF8Encoding, and System::Text::UnicodeEncoding.

◆ GetMaxCharCount()

ASPOSECPP_SHARED_API int System::Text::ICUEncoding::GetMaxCharCount ( int  byte_count)
overridevirtual

Get the maximum number of characters needed to decode a specified number of bytes.

Parameters
byte_countNumber of bytes to decode.
Returns
Number of bytes sufficient to decode any string of given character length.

Implements System::Text::Encoding.

Reimplemented in System::Text::UnicodeEncoding.

◆ GetPreamble()

ASPOSECPP_SHARED_API ArrayPtr<uint8_t> System::Text::ICUEncoding::GetPreamble ( )
overridevirtual

Returns a sequence of bytes that denotes the encoding (e. g. BOM).

Returns
Bytes sequence preamble.

Reimplemented from System::Text::Encoding.

Reimplemented in System::Text::UTF32Encoding, System::Text::UTF8Encoding, and System::Text::UnicodeEncoding.

◆ operator==()

ASPOSECPP_SHARED_API bool System::Text::ICUEncoding::operator== ( const ICUEncoding other) const

Compares encodings using codepages.

Parameters
otherEncoding to compare to.
Returns
True if codepages match, false otherwise.