Inherits System::Text::ICUEncoding.

Public Member Functions

 UnicodeEncoding ()
 Constructor. More...
 
 UnicodeEncoding (bool big_endian, bool byte_order_mark)
 
 UnicodeEncoding (bool big_endian, bool byte_order_mark, bool throw_on_invalid_bytes)
 
int GetHashCode () const override
 
bool Equals (SharedPtr< Object > obj) override
 
ArrayPtr< uint8_t > GetPreamble () override
 
int GetMaxCharCount (int byte_count) override
 
int GetMaxByteCount (int char_count) override
 
bool operator== (const UnicodeEncoding &) const
 
SharedPtr< ObjectClone () override
 
- Public Member Functions inherited from System::Text::ICUEncoding
 ICUEncoding (const Details::EncodingInfoInternal *encoding_info)
 
bool operator== (const ICUEncoding &other) const
 
int GetByteCount (const char_t *chars, int count) override
 
int GetBytes (const char_t *chars, int char_count, uint8_t *bytes, int byte_count) override
 
int GetCharCount (const uint8_t *bytes, int count) override
 
int GetChars (const uint8_t *bytes, int byte_count, char_t *chars, int char_count) override
 
DecoderPtr GetDecoder () override
 
EncoderPtr GetEncoder () override
 
- Public Member Functions inherited from System::Text::Encoding
bool Equals (SharedPtr< Object > obj) override
 
virtual int get_CodePage ()
 
virtual int get_WindowsCodePage ()
 
virtual String get_WebName ()
 
virtual String get_BodyName ()
 
virtual String get_EncodingName ()
 
virtual String get_HeaderName ()
 
virtual bool get_IsSingleByte ()
 
virtual bool get_IsBrowserDisplay ()
 
virtual bool get_IsBrowserSave ()
 
virtual bool get_IsMailNewsDisplay ()
 
virtual bool get_IsMailNewsSave ()
 
bool get_IsReadOnly ()
 
DecoderFallbackPtr get_DecoderFallback () const
 
void set_DecoderFallback (const DecoderFallbackPtr value)
 
const EncoderFallbackPtr get_EncoderFallback () const
 
void set_EncoderFallback (const EncoderFallbackPtr value)
 
virtual int GetByteCount (ArrayPtr< char_t > chars, int index, int count)
 
virtual int GetByteCount (const String &s)
 
virtual int GetByteCount (ArrayPtr< char_t > chars)
 
virtual int GetBytes (ArrayPtr< char_t > chars, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
 
virtual int GetBytes (const String &s, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
 
virtual ArrayPtr< uint8_t > GetBytes (const String &s)
 
virtual ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars, int index, int count)
 
virtual ArrayPtr< uint8_t > GetBytes (ArrayPtr< char_t > chars)
 
virtual int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual int GetCharCount (ArrayPtr< uint8_t > bytes)
 
virtual int GetChars (ArrayPtr< uint8_t > bytes, int byte_index, int byte_count, ArrayPtr< char_t > chars, int char_index)
 
virtual ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual ArrayPtr< char_t > GetChars (ArrayPtr< uint8_t > bytes)
 
virtual String GetString (uint8_t *bytes, int byte_count)
 
virtual String GetString (ArrayPtr< uint8_t > bytes)
 
virtual String GetString (ArrayPtr< uint8_t > bytes, int index, int count)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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)
 

Static Public Attributes

static constexpr int UNICODE_CODE_PAGE = 1200
 Little endian codepage number. More...
 
static constexpr int BIG_UNICODE_CODE_PAGE = 1201
 Big endian codepage number. More...
 
- Static Public Attributes inherited from System::Text::Encoding
static constexpr int DEFAULT_CODE_PAGE = 0
 Default codepage value. More...
 

Protected Member Functions

 ~UnicodeEncoding () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Text::ICUEncoding
 ~ICUEncoding () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Text::Encoding
 Encoding ()
 Default constructor. More...
 
 Encoding (int codepage)
 
 Encoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
 Encoding (const Details::EncodingInfoInternal *info)
 

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 ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes)
 
static ArrayPtr< uint8_t > Convert (const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes, int index, int count)
 
static EncodingPtr get_ASCII ()
 
static EncodingPtr get_BigEndianUnicode ()
 
static EncodingPtr get_Unicode ()
 
static EncodingPtr get_UTF8 ()
 
static EncodingPtr get_UTF8Unmarked ()
 
static EncodingPtr get_UTF32 ()
 
static EncodingPtr get_BigEndianUTF32 ()
 
static EncodingPtr get_UTF7 ()
 
static EncodingPtr get_Latin1 ()
 Gets Latin1 encoding. FOR INTERNAL USE. More...
 
static EncodingPtr GetEncoding (const String &name)
 
static EncodingPtr GetEncoding (int codepage)
 
static EncodingPtr GetEncoding (int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
static EncodingPtr GetEncoding (const String &name, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
 
static EncodingPtr get_Default ()
 
static 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...
 

Detailed Description

Unicode encoding. 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

◆ UnicodeEncoding() [1/3]

System::Text::UnicodeEncoding::UnicodeEncoding ( )

Constructor.

◆ UnicodeEncoding() [2/3]

System::Text::UnicodeEncoding::UnicodeEncoding ( bool  big_endian,
bool  byte_order_mark 
)

Constructor.

Parameters
big_endianIf true, use big endian, otherwise use little endian.
byte_order_markIf true, provide BOM.

◆ UnicodeEncoding() [3/3]

System::Text::UnicodeEncoding::UnicodeEncoding ( bool  big_endian,
bool  byte_order_mark,
bool  throw_on_invalid_bytes 
)

Constructor.

Parameters
big_endianIf true, use big endian, otherwise use little endian.
byte_order_markIf true, provide BOM.
throw_on_invalid_bytesIf true, throw on invalid bytes, otherwise skip them.

◆ ~UnicodeEncoding()

System::Text::UnicodeEncoding::~UnicodeEncoding ( )
overrideprotected

Destructor.

Member Function Documentation

◆ Clone()

SharedPtr<Object> System::Text::UnicodeEncoding::Clone ( )
overridevirtual

Clones encoding object.

Returns
Encoding object clone.

Reimplemented from System::Text::Encoding.

◆ Equals()

bool System::Text::UnicodeEncoding::Equals ( SharedPtr< Object obj)
override

Compares encodings.

Parameters
objObject to compare to.
Returns
True if both objects are of same encoding, false otherwise.

◆ GetHashCode()

int System::Text::UnicodeEncoding::GetHashCode ( ) const
overridevirtual

Hashes encoding.

Returns
Hash code.

Reimplemented from System::Text::Encoding.

◆ GetMaxByteCount()

int System::Text::UnicodeEncoding::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.

Reimplemented from System::Text::ICUEncoding.

◆ GetMaxCharCount()

int System::Text::UnicodeEncoding::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.

Reimplemented from System::Text::ICUEncoding.

◆ GetPreamble()

ArrayPtr<uint8_t> System::Text::UnicodeEncoding::GetPreamble ( )
overridevirtual

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

Returns
Bytes sequence preamble.

Reimplemented from System::Text::ICUEncoding.

◆ operator==()

bool System::Text::UnicodeEncoding::operator== ( const UnicodeEncoding ) const

Compares encodings by codepages and flags.

Returns
True if codepages and flags match, false otherwise.

Member Data Documentation

◆ BIG_UNICODE_CODE_PAGE

constexpr int System::Text::UnicodeEncoding::BIG_UNICODE_CODE_PAGE = 1201
static

Big endian codepage number.

◆ UNICODE_CODE_PAGE

constexpr int System::Text::UnicodeEncoding::UNICODE_CODE_PAGE = 1200
static

Little endian codepage number.