System::Text::ICUDecoder Class Reference

Inherits System::Text::Decoder.

Public Types

typedef Decoder Base
 Base type. 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...
 

Public Member Functions

 ICUDecoder (ICUEncoding *encoding)
 
virtual ~ICUDecoder ()
 Destructor. More...
 
virtual void Reset ()
 Sets internal variables to initial state. More...
 
virtual int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count)
 
virtual int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count, bool flush)
 
virtual int GetCharCount (const uint8_t *bytes, int count, bool flush)
 
virtual int GetChars (ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, ArrayPtr< char_t > chars, int charIndex)
 
virtual int GetChars (ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, ArrayPtr< char_t > chars, int charIndex, bool flush)
 
virtual int GetChars (const uint8_t *bytes, int byteCount, char_t *chars, int charCount, bool flush)
 
virtual void Convert (ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, ArrayPtr< char_t > chars, int charIndex, int charCount, bool flush, int &bytesUsed, int &charsUsed, bool &completed)
 
virtual void Convert (const uint8_t *bytes, int byteCount, char_t *chars, int charCount, bool flush, int &bytesUsed, int &charsUsed, bool &completed)
 
- Public Member Functions inherited from System::Text::Decoder
DecoderFallbackPtr get_Fallback () const
 
void set_Fallback (DecoderFallbackPtr value)
 
DecoderFallbackBufferPtr get_FallbackBuffer () const
 
- 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. 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)
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from System::Text::Decoder
 Decoder ()
 Constructor. More...
 

Detailed Description

Decoder that uses ICU for decoding. 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.

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ ICUDecoder()

System::Text::ICUDecoder::ICUDecoder ( ICUEncoding encoding)

Constructor.

Parameters
encodingEncoding to copy parameters from.

◆ ~ICUDecoder()

virtual System::Text::ICUDecoder::~ICUDecoder ( )
virtual

Destructor.

Member Function Documentation

◆ Convert() [1/2]

virtual void System::Text::ICUDecoder::Convert ( ArrayPtr< uint8_t >  bytes,
int  byteIndex,
int  byteCount,
ArrayPtr< char_t >  chars,
int  charIndex,
int  charCount,
bool  flush,
int &  bytesUsed,
int &  charsUsed,
bool &  completed 
)
inlinevirtual

Converts bytes to characters.

Parameters
bytesBytes to decode.
byteIndexInput buffer offset.
byteCountInput buffer size.
charsDestination character buffer.
charIndexDestination array offset.
charCountDestination array size.
flushIf true, cleans internal decoder state after calculation.
bytesUsedReference to variable to store count of bytes read.
charsUsedReference to variable to store count of characters written.
completedReference to variable to be set to true if input buffer was exhausted and to false otherwise.

Reimplemented from System::Text::Decoder.

◆ Convert() [2/2]

virtual void System::Text::ICUDecoder::Convert ( const uint8_t *  bytes,
int  byteCount,
char_t *  chars,
int  charCount,
bool  flush,
int &  bytesUsed,
int &  charsUsed,
bool &  completed 
)
virtual

Converts bytes to characters.

Parameters
bytesBytes to decode.
byteCountInput buffer size.
charsDestination character buffer.
charCountDestination array size.
flushIf true, cleans internal decoder state after calculation.
bytesUsedReference to variable to store count of bytes read.
charsUsedReference to variable to store count of characters written.
completedReference to variable to be set to true if input buffer was exhausted and to false otherwise.

Reimplemented from System::Text::Decoder.

◆ GetCharCount() [1/3]

virtual int System::Text::ICUDecoder::GetCharCount ( ArrayPtr< uint8_t >  bytes,
int  index,
int  count 
)
inlinevirtual

Gets the number of characters needed to decode a buffer.

Parameters
bytesBytes to decode.
indexBuffer offset.
countNumber of bytes to decode.
Returns
Number of characters required to decode the buffer.

Reimplemented from System::Text::Decoder.

◆ GetCharCount() [2/3]

virtual int System::Text::ICUDecoder::GetCharCount ( ArrayPtr< uint8_t >  bytes,
int  index,
int  count,
bool  flush 
)
inlinevirtual

Gets the number of characters needed to decode a buffer.

Parameters
bytesBytes to decode.
indexBuffer offset.
countNumber of bytes to decode.
flushIf true, cleans internal decoder state after calculation.
Returns
Number of characters required to decode the buffer.

Reimplemented from System::Text::Decoder.

◆ GetCharCount() [3/3]

virtual int System::Text::ICUDecoder::GetCharCount ( const uint8_t *  bytes,
int  count,
bool  flush 
)
virtual

Gets the number of characters needed to decode a buffer.

Parameters
bytesBytes to decode.
countNumber of bytes to decode.
flushIf true, cleans internal decoder state after calculation.
Returns
Number of characters required to decode the buffer.

Reimplemented from System::Text::Decoder.

◆ GetChars() [1/3]

virtual int System::Text::ICUDecoder::GetChars ( ArrayPtr< uint8_t >  bytes,
int  byteIndex,
int  byteCount,
ArrayPtr< char_t >  chars,
int  charIndex 
)
inlinevirtual

Get the characters that result from decoding a buffer.

Parameters
bytesBytes to decode.
byteIndexInput buffer offset.
byteCountInput buffer size.
charsDestination character buffer.
charIndexDestination array offset.
Returns
Number of characters written.

Reimplemented from System::Text::Decoder.

◆ GetChars() [2/3]

virtual int System::Text::ICUDecoder::GetChars ( ArrayPtr< uint8_t >  bytes,
int  byteIndex,
int  byteCount,
ArrayPtr< char_t >  chars,
int  charIndex,
bool  flush 
)
inlinevirtual

Get the characters that result from decoding a buffer.

Parameters
bytesBytes to decode.
byteIndexInput buffer offset.
byteCountInput buffer size.
charsDestination character buffer.
charIndexDestination array offset.
flushIf true, cleans internal decoder state after calculation.
Returns
Number of characters written.

Reimplemented from System::Text::Decoder.

◆ GetChars() [3/3]

virtual int System::Text::ICUDecoder::GetChars ( const uint8_t *  bytes,
int  byteCount,
char_t *  chars,
int  charCount,
bool  flush 
)
virtual

Get the characters that result from decoding a buffer.

Parameters
bytesBytes to decode.
byteCountInput buffer size.
charsDestination character buffer.
charCountDestination array size.
flushIf true, cleans internal decoder state after calculation.
Returns
Number of characters written.

Reimplemented from System::Text::Decoder.

◆ Reset()

virtual void System::Text::ICUDecoder::Reset ( )
virtual

Sets internal variables to initial state.

Reimplemented from System::Text::Decoder.