System::Text::Encoder Class Reference

Inherits System::Object.

Inherited by System::Text::EncodingEncoder, and System::Text::ICUEncoder.

Public Member Functions

EncoderFallbackPtr get_Fallback () const
 
ASPOSECPP_SHARED_API void set_Fallback (EncoderFallbackPtr value)
 
ASPOSECPP_SHARED_API const EncoderFallbackBufferPtr get_FallbackBuffer () const
 
virtual ASPOSECPP_SHARED_API int GetByteCount (ArrayPtr< char_t > chars, int index, int count, bool flush)
 
virtual ASPOSECPP_SHARED_API int GetByteCount (const char_t *chars, int count, bool flush)
 
virtual ASPOSECPP_SHARED_API int GetBytes (ArrayPtr< char_t > chars, int charIndex, int charCount, ArrayPtr< uint8_t > bytes, int byteIndex, bool flush)
 
virtual ASPOSECPP_SHARED_API int GetBytes (const char_t *chars, int charCount, uint8_t *bytes, int byteCount, bool flush)
 
virtual ASPOSECPP_SHARED_API void Reset ()
 Cleans encoder internal state. More...
 
virtual ASPOSECPP_SHARED_API void Convert (ArrayPtr< char_t > chars, int charIndex, int charCount, ArrayPtr< uint8_t > bytes, int byteIndex, int byteCount, bool flush, int &charsUsed, int &bytesUsed, bool &completed)
 
virtual ASPOSECPP_SHARED_API void Convert (const char_t *chars, int charCount, uint8_t *bytes, int byteCount, bool flush, int &charsUsed, int &bytesUsed, bool &completed)
 
- 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. 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)
 

Protected Member Functions

ASPOSECPP_SHARED_API Encoder ()
 Constructor. More...
 

Additional Inherited Members

- 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::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

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

◆ Encoder()

ASPOSECPP_SHARED_API System::Text::Encoder::Encoder ( )
protected

Constructor.

Member Function Documentation

◆ Convert() [1/2]

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

Converts characters to bytes.

Parameters
charsCharacters to encode.
charIndexInput buffer offset.
charCountInput buffer size.
bytesDestination byte buffer.
byteIndexDestination array offset.
byteCountDestination array size.
flushIf true, cleans internal encoder state after calculation.
charsUsedReference to variable to store count of characters read.
bytesUsedReference to variable to store count of bytes written.
completedReference to variable to be set to true if input buffer was exhausted and to false otherwise.

Reimplemented in System::Text::ICUEncoder, and System::Text::EncodingEncoder.

◆ Convert() [2/2]

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

Converts characters to bytes.

Parameters
charsCharacters to encode.
charCountInput buffer size.
bytesDestination byte buffer.
byteCountDestination array size.
flushIf true, cleans internal encoder state after calculation.
charsUsedReference to variable to store count of characters read.
bytesUsedReference to variable to store count of bytes written.
completedReference to variable to be set to true if input buffer was exhausted and to false otherwise.

Reimplemented in System::Text::ICUEncoder, and System::Text::EncodingEncoder.

◆ get_Fallback()

EncoderFallbackPtr System::Text::Encoder::get_Fallback ( ) const
inline

Gets error handling fallback.

Returns
Fallback object.

◆ get_FallbackBuffer()

ASPOSECPP_SHARED_API const EncoderFallbackBufferPtr System::Text::Encoder::get_FallbackBuffer ( ) const

Gets fallback buffer.

Returns
Fallback buffer object.

◆ GetByteCount() [1/2]

virtual ASPOSECPP_SHARED_API int System::Text::Encoder::GetByteCount ( ArrayPtr< char_t >  chars,
int  index,
int  count,
bool  flush 
)
virtual

Gets the number of bytes needed to encode a buffer.

Parameters
charsCharacters to encode.
indexBuffer offset.
countNumber of characters to encode.
flushIf true, cleans internal encoder state after calculation.
Returns
Number of bytes required to encode the buffer.

Reimplemented in System::Text::ICUEncoder.

◆ GetByteCount() [2/2]

virtual ASPOSECPP_SHARED_API int System::Text::Encoder::GetByteCount ( const char_t *  chars,
int  count,
bool  flush 
)
virtual

Gets the number of bytes needed to encode a buffer.

Parameters
charsCharacters to encode.
countNumber of characters to encode.
flushIf true, cleans internal encoder state after calculation.
Returns
Number of bytes required to encode the buffer.

Reimplemented in System::Text::ICUEncoder.

◆ GetBytes() [1/2]

virtual ASPOSECPP_SHARED_API int System::Text::Encoder::GetBytes ( ArrayPtr< char_t >  chars,
int  charIndex,
int  charCount,
ArrayPtr< uint8_t >  bytes,
int  byteIndex,
bool  flush 
)
virtual

Get the bytes that result from encoding a buffer.

Parameters
charsCharacters to encode.
charIndexSource array offset.
charCountSource subarray length.
bytesDestination byte buffer.
byteIndexDestination buffer offset.
flushIf true, cleans internal encoder state after calculation.
Returns
Number of bytes written.

Reimplemented in System::Text::ICUEncoder.

◆ GetBytes() [2/2]

virtual ASPOSECPP_SHARED_API int System::Text::Encoder::GetBytes ( const char_t *  chars,
int  charCount,
uint8_t *  bytes,
int  byteCount,
bool  flush 
)
virtual

Get the bytes that result from encoding a buffer.

Parameters
charsCharacters to encode.
charCountSource array length.
bytesDestination byte buffer.
byteCountDestination buffer size.
flushIf true, cleans internal encoder state after calculation.
Returns
Number of bytes written.

Reimplemented in System::Text::ICUEncoder.

◆ Reset()

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

Cleans encoder internal state.

Reimplemented in System::Text::ICUEncoder.

◆ set_Fallback()

ASPOSECPP_SHARED_API void System::Text::Encoder::set_Fallback ( EncoderFallbackPtr  value)

Sets error handling fallback.

Parameters
valueFallback object.