csharp-to-cpp/apireference/encoding_8h_source.html

#pragma once


#include <system/object.h>

#include <system/text/decoder_fallback.h>

#include <system/text/encoder_fallback.h>

#include <system/text/decoder.h>

#include <system/text/encoder.h>

#include <system/text/encoding_decoder.h>

#include <system/text/encoding_encoder.h>

#include <system/exceptions.h>

#include <system/details/array_view.h>

#include <system/details/stack_array.h>

#include <fwd.h>


namespace System { namespace Text {


namespace Details {

    struct EncodingInfoInternal;

}


class Encoding;


class ASPOSECPP_SHARED_CLASS EncodingInfo final : public Object

{

public:

    EncodingInfo(int codepage, const String& name, const String& display_name)

        : m_codepage(codepage)

        , m_name(name)

        , m_display_name(display_name)

    {}


    int get_CodePage() const { return m_codepage; }

    const String& get_Name() const { return m_name; }

    const String& get_DisplayName() const { return m_display_name; }


    ASPOSECPP_SHARED_API EncodingPtr GetEncoding();


private:

    const int m_codepage;

    const String m_name;

    const String m_display_name;

};


class ASPOSECPP_SHARED_CLASS Encoding : public Object

{

    RTTI_INFO(System::Text::Encoding, ::System::BaseTypesInfo<System::Object>)


public:

    typedef System::SharedPtr<Encoding> Ptr;


    static constexpr int DEFAULT_CODE_PAGE = 0;


    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);


    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);


    virtual ASPOSECPP_SHARED_API int GetByteCount(ArrayPtr<char_t> chars, int index, int count);


    virtual ASPOSECPP_SHARED_API int GetByteCount(System::Details::ArrayView<char_t> chars, int index, int count);

    template<std::size_t N>

    int GetByteCount(const System::Details::StackArray<char_t, N> & chars, int index, int count)

    {

        return GetByteCount(static_cast<System::Details::ArrayView<char_t>>(chars), index, 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 GetByteCount(const char_t *chars, int count);


    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(System::Details::ArrayView<char_t> chars, int char_index, int char_count, System::Details::ArrayView<uint8_t> bytes, int byte_index);

    template<std::size_t SC, std::size_t  SB>

    int GetBytes(System::Details::StackArray<char_t, SC> &chars, int char_index, int char_count, System::Details::StackArray<uint8_t, SB> &bytes, int byte_index)

    {

        return GetBytes(static_cast<System::Details::ArrayView<char_t>>(chars), char_index, char_count, static_cast<System::Details::ArrayView<uint8_t>>(bytes), 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(const System::Details::ArrayView<char_t> &chars, int index, int count);

    template<std::size_t N>

    ArrayPtr<uint8_t> GetBytes(const System::Details::StackArray<char_t, N> &chars, int index, int count)

    {

        return GetBytes(static_cast<System::Details::ArrayView<char_t>>(chars), index, count);

    }


    virtual ASPOSECPP_SHARED_API ArrayPtr<uint8_t> GetBytes(ArrayPtr<char_t> chars);

    virtual ASPOSECPP_SHARED_API int GetBytes(const char_t* chars, int char_count, uint8_t* bytes, int byte_count);


    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 GetCharCount(const uint8_t* bytes, int count);


    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 int GetChars(const uint8_t *bytes, int byte_count, char_t *chars, int char_count);


    virtual ASPOSECPP_SHARED_API DecoderPtr GetDecoder();

    virtual ASPOSECPP_SHARED_API EncoderPtr GetEncoder();


    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(const System::Details::ArrayView<uint8_t> &bytes);

    template<std::size_t N>

    String GetString(System::Details::StackArray<uint8_t, N> &bytes)

    {

        return GetString(static_cast<System::Details::ArrayView<uint8_t>>(bytes));

    }


    virtual ASPOSECPP_SHARED_API String GetString(ArrayPtr<uint8_t> bytes, int index, int count);

    virtual ASPOSECPP_SHARED_API String GetString(const System::Details::ArrayView<uint8_t> &bytes, int index, int count);

    template<std::size_t N>

    String GetString(System::Details::StackArray<uint8_t, N> bytes, int index, int count)

    {

        return GetString(static_cast<System::Details::ArrayView<uint8_t>>(bytes), index, count);

    }


    virtual ASPOSECPP_SHARED_API int GetMaxByteCount(int char_count) = 0;

    virtual ASPOSECPP_SHARED_API int GetMaxCharCount(int byte_count) = 0;


    virtual ASPOSECPP_SHARED_API SharedPtr<Object> Clone();

    virtual ASPOSECPP_SHARED_API ArrayPtr<uint8_t> GetPreamble();


    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();

    // Gets the standard UTF-32 encoding object.

    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();


    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<EncodingInfoPtr> GetEncodings();


protected:

    const Details::EncodingInfoInternal* m_info;

    const int m_codepage;

    bool m_is_read_only = true;


    ASPOSECPP_SHARED_API Encoding();

    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);


private:

    void SetDefaultFallbacks();

    void VerifyInternalData();


    DecoderFallbackPtr m_decoder_fallback;

    EncoderFallbackPtr m_encoder_fallback;

};


}} // System::Text

System::Object
Base class that enables using methods available for System.Object class in C#. All non-trivial classe...
Definition: object.h:62

System::SmartPtr< System::Text::Encoding >

System::String
String class used across the library. Is a substitute for C# System.String when translating code....
Definition: string.h:122

System::Text::Encoding
Encoding services.
Definition: encoding.h:67

System::Text::Encoding::GetByteCount
virtual int GetByteCount(ArrayPtr< char_t > chars, int index, int count)
Get the number of characters needed to encode a character buffer.

System::Text::Encoding::GetMaxCharCount
virtual int GetMaxCharCount(int byte_count)=0
Get the maximum number of characters needed to decode a specified number of bytes.

System::Text::Encoding::GetBytes
virtual int GetBytes(System::Details::ArrayView< char_t > chars, int char_index, int char_count, System::Details::ArrayView< uint8_t > bytes, int byte_index)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetBytes
virtual int GetBytes(ArrayPtr< char_t > chars, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetBytes
virtual ArrayPtr< uint8_t > GetBytes(ArrayPtr< char_t > chars, int index, int count)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetString
virtual String GetString(const System::Details::ArrayView< uint8_t > &bytes)
Decodes a buffer of bytes into a string.

System::Text::Encoding::Encoding
Encoding(int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
Constructor.

System::Text::Encoding::Clone
virtual SharedPtr< Object > Clone()
Clones encoding object.

System::Text::Encoding::GetEncoding
static EncodingPtr GetEncoding(const String &name)
Gets encoding by name.

System::Text::Encoding::GetString
virtual String GetString(const System::Details::ArrayView< uint8_t > &bytes, int index, int count)
Decodes a buffer of bytes into a string.

System::Text::Encoding::get_IsBrowserSave
virtual bool get_IsBrowserSave()
Checks whether encoding can be used in browser to save content.

System::Text::Encoding::GetBytes
ArrayPtr< uint8_t > GetBytes(const System::Details::StackArray< char_t, N > &chars, int index, int count)
Get the bytes that result from encoding a character buffer.
Definition: encoding.h:250

System::Text::Encoding::GetMaxByteCount
virtual int GetMaxByteCount(int char_count)=0
Get the maximum number of bytes needed to encode a specified number of characters.

System::Text::Encoding::get_WindowsCodePage
virtual int get_WindowsCodePage()
Gets Windows codepage ID.

System::Text::Encoding::get_BigEndianUnicode
static EncodingPtr get_BigEndianUnicode()
Gets the standard big-endian Unicode encoding object.

System::Text::Encoding::GetChars
virtual ArrayPtr< char_t > GetChars(ArrayPtr< uint8_t > bytes)
Get the characters that result from decoding a byte buffer.

System::Text::Encoding::get_UTF8Unmarked
static EncodingPtr get_UTF8Unmarked()
Only internal, to be used by the class libraries: Unmarked and non-input-validating.

System::Text::Encoding::Encoding
Encoding(int codepage)
Constructor.

System::Text::Encoding::GetPreamble
virtual ArrayPtr< uint8_t > GetPreamble()
Returns a sequence of bytes that denotes the encoding (e. g. BOM).

System::Text::Encoding::get_BodyName
virtual String get_BodyName()
Gets mail agent body compatible encoding name.

System::Text::Encoding::GetByteCount
virtual int GetByteCount(ArrayPtr< char_t > chars)
Get the number of characters needed to encode a character buffer.

System::Text::Encoding::get_IsMailNewsDisplay
virtual bool get_IsMailNewsDisplay()
Checks whether encoding can be used in mail client to display content.

System::Text::Encoding::GetByteCount
virtual int GetByteCount(System::Details::ArrayView< char_t > chars, int index, int count)
Get the number of characters needed to encode a character buffer.

System::Text::Encoding::get_UTF7
static EncodingPtr get_UTF7()
Gets the standard UTF-7 encoding object.

System::Text::Encoding::m_codepage
const int m_codepage
Code page identifier.
Definition: encoding.h:437

System::Text::Encoding::GetEncoding
static EncodingPtr GetEncoding(int codepage, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
Gets encoding by codepage.

System::Text::Encoding::GetCharCount
virtual int GetCharCount(const uint8_t *bytes, int count)
Get the number of characters needed to decode a byte buffer.

System::Text::Encoding::get_CodePage
virtual int get_CodePage()
Gets Windows codepage ID.

System::Text::Encoding::get_HeaderName
virtual String get_HeaderName()
Gets mail agent header compatible encoding name.

System::Text::Encoding::Ptr
System::SharedPtr< Encoding > Ptr
RTTI.
Definition: encoding.h:73

System::Text::Encoding::GetCharCount
virtual int GetCharCount(ArrayPtr< uint8_t > bytes, int index, int count)
Get the number of characters needed to decode a byte buffer.

System::Text::Encoding::Encoding
Encoding(const Details::EncodingInfoInternal *info)
Internal constructor.

System::Text::Encoding::GetByteCount
virtual int GetByteCount(const char_t *chars, int count)
Get the number of characters needed to encode a character buffer.

System::Text::Encoding::GetBytes
virtual ArrayPtr< uint8_t > GetBytes(const System::Details::ArrayView< char_t > &chars, int index, int count)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetEncoder
virtual EncoderPtr GetEncoder()
Get an encoder that forwards requests to this object.

System::Text::Encoding::get_UTF32
static EncodingPtr get_UTF32()

System::Text::Encoding::GetByteCount
int GetByteCount(const System::Details::StackArray< char_t, N > &chars, int index, int count)
Get the number of characters needed to encode a character buffer.
Definition: encoding.h:172

System::Text::Encoding::get_WebName
virtual String get_WebName()
Gets IANA-compatible encoding name.

System::Text::Encoding::GetHashCode
int GetHashCode() const override
Hashes encoding.

System::Text::Encoding::Convert
static ArrayPtr< uint8_t > Convert(const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes)
Converts bytes between two encodings.

System::Text::Encoding::GetBytes
virtual ArrayPtr< uint8_t > GetBytes(const String &s)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetBytes
int GetBytes(System::Details::StackArray< char_t, SC > &chars, int char_index, int char_count, System::Details::StackArray< uint8_t, SB > &bytes, int byte_index)
Get the bytes that result from encoding a character buffer.
Definition: encoding.h:215

System::Text::Encoding::get_BigEndianUTF32
static EncodingPtr get_BigEndianUTF32()
Gets the standard big-endian UTF-32 encoding object.

System::Text::Encoding::GetEncodings
static ArrayPtr< EncodingInfoPtr > GetEncodings()
Gets list of known encodings.

System::Text::Encoding::get_UTF8
static EncodingPtr get_UTF8()
Gets the standard UTF-8 encoding object.

System::Text::Encoding::get_IsBrowserDisplay
virtual bool get_IsBrowserDisplay()
Checks whether encoding can be used in browser to display content.

System::Text::Encoding::set_EncoderFallback
void set_EncoderFallback(const EncoderFallbackPtr &value)
Sets encoder fallback.

System::Text::Encoding::GetBytes
virtual ArrayPtr< uint8_t > GetBytes(ArrayPtr< char_t > chars)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetChars
virtual ArrayPtr< char_t > GetChars(ArrayPtr< uint8_t > bytes, int index, int count)
Get the characters that result from decoding a byte buffer.

System::Text::Encoding::GetString
virtual String GetString(uint8_t *bytes, int byte_count)
Decodes a buffer of bytes into a string.

System::Text::Encoding::get_Latin1
static EncodingPtr get_Latin1()
Gets Latin1 encoding. FOR INTERNAL USE.

System::Text::Encoding::GetString
virtual String GetString(ArrayPtr< uint8_t > bytes, int index, int count)
Decodes a buffer of bytes into a string.

System::Text::Encoding::get_Unicode
static EncodingPtr get_Unicode()
Gets the standard Unicode encoding object.

System::Text::Encoding::GetString
String GetString(System::Details::StackArray< uint8_t, N > bytes, int index, int count)
Decodes a buffer of bytes into a string.
Definition: encoding.h:356

System::Text::Encoding::GetChars
virtual int GetChars(const uint8_t *bytes, int byte_count, char_t *chars, int char_count)
Get the characters that result from decoding a byte buffer.

System::Text::Encoding::set_DecoderFallback
void set_DecoderFallback(const DecoderFallbackPtr &value)
Sets decoder fallback.

System::Text::Encoding::GetCharCount
virtual int GetCharCount(ArrayPtr< uint8_t > bytes)
Get the number of characters needed to decode a byte buffer.

System::Text::Encoding::get_EncoderFallback
const EncoderFallbackPtr get_EncoderFallback() const
Gets encoder fallback.

System::Text::Encoding::m_info
const Details::EncodingInfoInternal * m_info
Pointer to internal encoding info.
Definition: encoding.h:435

System::Text::Encoding::GetBytes
virtual int GetBytes(const char_t *chars, int char_count, uint8_t *bytes, int byte_count)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetEncoding
static EncodingPtr GetEncoding(int codepage)
Gets encoding by codepage.

System::Text::Encoding::get_IsMailNewsSave
virtual bool get_IsMailNewsSave()
Checks whether encoding can be used in mail client to save content.

System::Text::Encoding::GetEncoding
static EncodingPtr GetEncoding(const String &name, const EncoderFallbackPtr &encoder_fallback, const DecoderFallbackPtr &decoder_fallback)
Gets encoding by name.

System::Text::Encoding::get_Default
static EncodingPtr get_Default()
Gets default encoding.

System::Text::Encoding::get_EncodingName
virtual String get_EncodingName()
Gets human-readable encoding name.

System::Text::Encoding::Encoding
Encoding()
Default constructor.

System::Text::Encoding::GetByteCount
virtual int GetByteCount(const String &s)
Get the number of characters needed to encode a string.

System::Text::Encoding::get_ASCII
static EncodingPtr get_ASCII()
Gets ASCII encoding.

System::Text::Encoding::Equals
bool Equals(SharedPtr< Object > obj) override
Compares encodings.

System::Text::Encoding::get_IsReadOnly
bool get_IsReadOnly()
Checks whether encoding is read-only.

System::Text::Encoding::GetChars
virtual int GetChars(ArrayPtr< uint8_t > bytes, int byte_index, int byte_count, ArrayPtr< char_t > chars, int char_index)
Get the characters that result from decoding a byte buffer.

System::Text::Encoding::GetString
String GetString(System::Details::StackArray< uint8_t, N > &bytes)
Decodes a buffer of bytes into a string.
Definition: encoding.h:333

System::Text::Encoding::get_IsSingleByte
virtual bool get_IsSingleByte()
Checks whether encoding is single byte.

System::Text::Encoding::GetString
virtual String GetString(ArrayPtr< uint8_t > bytes)
Decodes a buffer of bytes into a string.

System::Text::Encoding::get_DecoderFallback
DecoderFallbackPtr get_DecoderFallback() const
Gets decoder fallback.

System::Text::Encoding::GetBytes
virtual int GetBytes(const String &s, int char_index, int char_count, ArrayPtr< uint8_t > bytes, int byte_index)
Get the bytes that result from encoding a character buffer.

System::Text::Encoding::GetDecoder
virtual DecoderPtr GetDecoder()
Get a decoder that forwards requests to this object.

System::Text::Encoding::Convert
static ArrayPtr< uint8_t > Convert(const EncodingPtr &src_encoding, const EncodingPtr &dst_encoding, const ArrayPtr< uint8_t > &bytes, int index, int count)
Converts bytes between two encodings.

System::Text::EncodingInfo
Brief info on encoding. Objects of this class should only be allocated using System::MakeObject() fun...
Definition: encoding.h:30

System::Text::EncodingInfo::get_Name
const String & get_Name() const
Gets encoding short name.
Definition: encoding.h:47

System::Text::EncodingInfo::get_CodePage
int get_CodePage() const
Gets codepage ID.
Definition: encoding.h:44

System::Text::EncodingInfo::get_DisplayName
const String & get_DisplayName() const
Gets full localized encoding name.
Definition: encoding.h:50

System::Text::EncodingInfo::GetEncoding
EncodingPtr GetEncoding()
Gets encoding described by info.

System::Text::EncodingInfo::EncodingInfo
EncodingInfo(int codepage, const String &name, const String &display_name)
Constuctor.
Definition: encoding.h:36

System::Drawing::Imaging::ColorAdjustType::Text
@ Text
Defines color adjustment information for text.

System
Definition: db_command.h:9