note
	description: "Helper routines for encoding conversion."
	legal: "See notice at end of class."
	status: "See notice at end of class."
	date: "$Date: 2020-05-19 14:18:09 +0000 (Tue, 19 May 2020) $"
	revision: "$Revision: 104255 $"

class interface
	ENCODING_HELPER

create 
	default_create

feature -- Conversion

	multi_byte_to_pointer (a_string: READABLE_STRING_8): MANAGED_POINTER
			-- Managed pointer of a_string.
		require
			a_string_not_void: a_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	wide_string_to_pointer (a_string: READABLE_STRING_32): MANAGED_POINTER
			-- Managed pointer of a_string which is taken as
			-- 16bits string. High 16bits of characters of a_string are discarded.
		require
			a_string_not_void: a_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	pointer_to_multi_byte (a_multi_string: POINTER; a_count: INTEGER_32): STRING_8
			-- STRING_8 read from a_multi_string.
		require
			a_multi_string_not_default: a_multi_string /= default_pointer
			a_count_non_negative: a_count >= 0
		ensure
			instance_free: class
			result_not_void: Result /= Void

	pointer_to_wide_string (a_w_string: POINTER; a_count: INTEGER_32): STRING_32
			-- STRING_32 read from a_w_string of a_count bytes.
		require
			a_w_string_not_default: a_w_string /= default_pointer
			a_count_non_negative: a_count >= 0
		ensure
			instance_free: class
			result_not_void: Result /= Void

	pointer_to_string_32 (a_w_string: POINTER; a_count: INTEGER_32): STRING_32
			-- STRING_32 read from a_w_string of a_count bytes.
		require
			a_w_string_not_default: a_w_string /= default_pointer
			a_count_non_negative: a_count >= 0
		ensure
			instance_free: class
			result_not_void: Result /= Void

	string_32_to_multi_byte (a_string: STRING_32): STRING_8
			-- Byte stream of a_string in endianness of the current platform.
		require
			a_string_not_void: a_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	string_8_to_wide_string (a_w_string: STRING_8): STRING_32
			-- Interpret a_w_string as a sequence of 2-byte characters into a STRING_32
			-- in endianness of the current platform.
		require
			a_w_string_not_void: a_w_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	string_16_to_stream (a_string: STRING_32): STRING_8
			-- We use a_string as 2 bytes encoding string, the first two bytes are not used.
			-- in the endianness of the current platform.
		require
			a_string_not_void: a_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void
			valid_count: Result.count = a_string.count * 2

	string_general_to_stream (a_string: READABLE_STRING_GENERAL): STRING_8
			-- Streamize a_string.
		require
			a_string_not_void: a_string /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void
	
feature -- Endian

	string_32_switch_endian (a_str: STRING_32): STRING_32
			-- Switch endian of a_str for both high and low bits.
		require
			a_str_not_void: a_str /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	string_16_switch_endian (a_str: STRING_32): STRING_32
			-- Switch endian of a_str for low bits.
			-- High bits are cleaned.
		require
			a_str_not_void: a_str /= Void
		ensure
			instance_free: class
			result_not_void: Result /= Void

	Is_little_endian: BOOLEAN
			-- Is this system little endian?
		ensure
			instance_free: class
	
note
	library: "Encoding: Library of reusable components for Eiffel."
	copyright: "Copyright (c) 1984-2020, Eiffel Software and others"
	license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
	source: "[
		Eiffel Software
		5949 Hollister Ave., Goleta, CA 93117 USA
		Telephone 805-685-1006, Fax 805-685-6869
		Website http://www.eiffel.com
		Customer support http://support.eiffel.com
	]"

end -- class ENCODING_HELPER

Generated by ISE EiffelStudio