System::Text::Decoder Class Reference

Encapsulates decoding byte sequence into character sequence. 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. More...

#include "decoder.h"

Inherits System::Object.

Inherited by System::Text::EncodingDecoder, and System::Text::ICUDecoder.

Public Member Functions

DecoderFallbackPtr get_Fallback () const
 Gets error handling fallback. More...
 
ASPOSECPP_SHARED_API void set_Fallback (const DecoderFallbackPtr &value)
 Sets error handling fallback. More...
 
ASPOSECPP_SHARED_API DecoderFallbackBufferPtr get_FallbackBuffer () const
 Gets fallback buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count)
 Gets the number of characters needed to decode a buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetCharCount (ArrayPtr< uint8_t > bytes, int index, int count, bool flush)
 Gets the number of characters needed to decode a buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetCharCount (const uint8_t *bytes, int count, bool flush)
 Gets the number of characters needed to decode a buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetChars (ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, ArrayPtr< char_t > chars, int charIndex)
 Get the characters that result from decoding a buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetChars (ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, ArrayPtr< char_t > chars, int charIndex, bool flush)
 Get the characters that result from decoding a buffer. More...
 
virtual ASPOSECPP_SHARED_API int GetChars (const uint8_t *bytes, int byteCount, char_t *chars, int charCount, bool flush)
 Get the characters that result from decoding a buffer. More...
 
virtual ASPOSECPP_SHARED_API void Reset ()
 Cleans decoder internal state. More...
 
virtual ASPOSECPP_SHARED_API 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)
 Converts bytes to characters. More...
 
virtual ASPOSECPP_SHARED_API void Convert (const uint8_t *bytes, int byteCount, char_t *chars, int charCount, bool flush, int &bytesUsed, int &charsUsed, bool &completed)
 Converts bytes to characters. More...
 
- 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

ASPOSECPP_SHARED_API Decoder ()
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Encapsulates decoding byte sequence into character sequence. 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

◆ Decoder()

ASPOSECPP_SHARED_API System::Text::Decoder::Decoder ( )
protected

Constructor.

Member Function Documentation

◆ Convert() [1/2]

virtual ASPOSECPP_SHARED_API void System::Text::Decoder::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

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 in System::Text::ICUDecoder, and System::Text::EncodingDecoder.

◆ Convert() [2/2]

virtual ASPOSECPP_SHARED_API void System::Text::Decoder::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 in System::Text::ICUDecoder, and System::Text::EncodingDecoder.

◆ get_Fallback()

DecoderFallbackPtr System::Text::Decoder::get_Fallback ( ) const
inline

Gets error handling fallback.

Returns
Fallback object.

◆ get_FallbackBuffer()

ASPOSECPP_SHARED_API DecoderFallbackBufferPtr System::Text::Decoder::get_FallbackBuffer ( ) const

Gets fallback buffer.

Returns
Fallback buffer object.

◆ GetCharCount() [1/3]

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

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 in System::Text::ICUDecoder.

◆ GetCharCount() [2/3]

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

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 in System::Text::ICUDecoder.

◆ GetCharCount() [3/3]

virtual ASPOSECPP_SHARED_API int System::Text::Decoder::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 in System::Text::ICUDecoder.

◆ GetChars() [1/3]

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

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 in System::Text::ICUDecoder.

◆ GetChars() [2/3]

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

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 in System::Text::ICUDecoder.

◆ GetChars() [3/3]

virtual ASPOSECPP_SHARED_API int System::Text::Decoder::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 in System::Text::ICUDecoder.

◆ Reset()

virtual ASPOSECPP_SHARED_API void System::Text::Decoder::Reset ( )
virtual

Cleans decoder internal state.

Reimplemented in System::Text::ICUDecoder.

◆ set_Fallback()

ASPOSECPP_SHARED_API void System::Text::Decoder::set_Fallback ( const DecoderFallbackPtr value)

Sets error handling fallback.

Parameters
valueFallback object.