note
	description: "A mode (width, height, refresh rate, etc.) of a GAME_DISPLAY (screen)"
	author: "Louis Marchand"
	date: "Thu, 02 Apr 2015 02:40:10 +0000"
	revision: "2.0"

class 
	GAME_DISPLAY_MODE

create 
	make,
	make_with_refresh_rate


create {GAME_SDL_ANY}
	own_from_pointer,
	shared_from_pointer

feature {NONE} -- Initialization

	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end

	make (a_width, a_height: INTEGER_32)
			-- Initialization for Current using only a_width and a_height.
		require
			display_mode_make_width_valid: a_width > 0
			display_mode_make_height_valid: a_height > 0
		do
			make_with_refresh_rate (a_width, a_height, 0)
		end

	make_from_pointer (a_mode: POINTER)
			-- Initialization for Current using a copy of the internal mode pointed by a_mode pointer.
			-- Note that the a_mode will not be free by Current.
		require
			display_mode_own_pointer_not_null: not a_mode.is_default_pointer
		do
			make_with_refresh_rate ({GAME_SDL_EXTERNAL}.get_display_mode_struct_w (a_mode), {GAME_SDL_EXTERNAL}.get_display_mode_struct_h (a_mode), {GAME_SDL_EXTERNAL}.get_display_mode_struct_refresh_rate (a_mode))
			set_pixel_format (create {GAME_PIXEL_FORMAT_READABLE}.make_from_flags ({GAME_SDL_EXTERNAL}.get_display_mode_struct_format (a_mode)))
		end

	make_with_refresh_rate (a_width, a_height, a_refresh_rate: INTEGER_32)
			-- Initialization for Current using a_width, a_height and a_refresh_rate.
		require
			display_mode_make_refresh_rate_valid: a_refresh_rate >= 0
			display_mode_make_width_valid: a_width > 0
			display_mode_make_height_valid: a_height > 0
		do
			make_structure
			set_pixel_format (create {GAME_PIXEL_FORMAT})
			set_width (a_width)
			set_height (a_height)
			set_refresh_rate (a_refresh_rate)
		end

	own_from_pointer (a_mode: POINTER)
			-- Initialization for Current using a_mode pointer.
			-- Note that the a_mode pointer is owned by Current. The client does not have to free it.
		require
			display_mode_own_pointer_not_null: not a_mode.is_default_pointer
		do
			create internal_item
			create managed_pointer.own_from_pointer (a_mode, structure_size)
			shared := False
		end

	shared_from_pointer (a_mode: POINTER)
			-- Initialization for Current using a_mode pointer.
			-- Note that the a_mode will not be free by Current.
		require
			display_mode_own_pointer_not_null: not a_mode.is_default_pointer
		do
			make_by_pointer (a_mode)
		ensure
			display_mode_own_internal_pointer_not_null: not item.is_default_pointer
		end
	
feature -- Initialization

	make_structure
			-- Initialize current with given structure_size.
			-- (from MEMORY_STRUCTURE)
		local
			null: POINTER
		do
			internal_item := null
			create managed_pointer.make (structure_size)
			shared := False
		ensure -- from MEMORY_STRUCTURE
			not_shared: not shared
		end

	make_by_pointer (a_ptr: POINTER)
			-- Initialize current with a_ptr.
			-- (from MEMORY_STRUCTURE)
		require -- from MEMORY_STRUCTURE
			a_ptr_not_null: a_ptr /= default_pointer
		do
			internal_item := a_ptr
			managed_pointer := Void
			shared := True
		ensure -- from MEMORY_STRUCTURE
			shared: shared
		end
	
feature -- Access

	generating_type: TYPE [detachable GAME_DISPLAY_MODE]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generating_type_not_void: Result /= Void
		end

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty
		end

	has_error: BOOLEAN
			-- Is the library has generate an error
			-- (from GAME_ERROR_MANAGER)

	height: INTEGER_32 assign set_height
			-- The height of `Current
		require
			pointer_exists: exists
		do
			Result := {GAME_SDL_EXTERNAL}.get_display_mode_struct_h (item)
		ensure
			display_mode_width_not_changed: width = old width
			display_mode_height_not_changed: height = old height
			display_mode_refresh_rate_not_changed: refresh_rate = old refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end

	is_equal (a_other: like Current): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
		require -- from ANY
			other_not_void: a_other /= Void
		require else
			pointer_exists: exists
		do
			if exists then
				Result := (width = a_other.width) and (height = a_other.height) and (refresh_rate = a_other.refresh_rate) and (pixel_format ~ a_other.pixel_format)
			else
				Result := not a_other.exists
			end
		ensure -- from ANY
			symmetric: Result implies a_other ~ Current
			consistent: standard_is_equal (a_other) implies Result
		end

	item: POINTER
			-- Access to memory area.
			-- (from MEMORY_STRUCTURE)
		local
			m: like managed_pointer
		do
			if shared then
				Result := internal_item
			else
				m := managed_pointer
				if m /= Void then
					Result := m.item
				end
			end
		end

	last_error: READABLE_STRING_GENERAL
			-- The last error generate by the library
			-- (from GAME_SDL_ANY)
		local
			l_string: C_STRING
		do
			if is_manual_error then
				Result := Precursor {GAME_ERROR_MANAGER}
			else
				create l_string.make_by_pointer ({GAME_SDL_EXTERNAL}.sdl_geterror)
				Result := l_string.string
			end
		end

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
		require -- from  ANY
			True
		require else
			pointer_exists: exists
		do
			if exists then
				Result := width.out + "x" + height.out + ", " + refresh_rate.out + "Hz, Format:" + pixel_format.out
			else
				Result := ""
			end
		ensure -- from ANY
			out_not_void: Result /= Void
		end

	pixel_format: GAME_PIXEL_FORMAT_READABLE assign set_pixel_format
			-- The internal format of the pixel representation in memory.
		require
			pointer_exists: exists
		do
			create Result.make_from_flags ({GAME_SDL_EXTERNAL}.get_display_mode_struct_format (item))
		end

	refresh_rate: INTEGER_32 assign set_refresh_rate
			-- The frame_rate of Current
		require
			pointer_exists: exists
		do
			Result := {GAME_SDL_EXTERNAL}.get_display_mode_struct_refresh_rate (item)
		ensure
			display_mode_width_not_changed: width = old width
			display_mode_height_not_changed: height = old height
			display_mode_refresh_rate_not_changed: refresh_rate = old refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end

	set_height (a_height: INTEGER_32)
			-- Assign height with the value of a_height.
		require
			pointer_exists: exists
		do
			{GAME_SDL_EXTERNAL}.set_display_mode_struct_h (item, a_height)
		ensure
			display_mode_width_not_changed: width = old width
			display_mode_height_changed: height = a_height
			display_mode_refresh_rate_not_changed: refresh_rate = old refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end

	set_pixel_format (a_pixel_format: like pixel_format)
			-- Assign the pixel_format of the pixel representation in memory to the value of a_pixel_format.
		require
			pointer_exists: exists
		do
			{GAME_SDL_EXTERNAL}.set_display_mode_struct_format (item, pixel_format.internal_index)
		end

	set_refresh_rate (a_refresh_rate: INTEGER_32)
			-- Assign refresh_rate with the value of a_refresh_rate.
		require
			pointer_exists: exists
		do
			{GAME_SDL_EXTERNAL}.set_display_mode_struct_refresh_rate (item, a_refresh_rate)
		ensure
			display_mode_width_not_changed: width = old width
			display_mode_height_not_changed: height = old height
			display_mode_refresh_rate_changed: refresh_rate = a_refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end

	set_width (a_width: INTEGER_32)
			-- Assign width with the value of a_width.
		require
			pointer_exists: exists
		do
			{GAME_SDL_EXTERNAL}.set_display_mode_struct_w (item, a_width)
		ensure
			display_mode_width_changed: width = a_width
			display_mode_height_not_changed: height = old height
			display_mode_refresh_rate_not_changed: refresh_rate = old refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end

	shared: BOOLEAN
			-- Is current memory area shared with others?
			-- (from MEMORY_STRUCTURE)

	width: INTEGER_32 assign set_width
			-- The width of Current
		require
			pointer_exists: exists
		do
			Result := {GAME_SDL_EXTERNAL}.get_display_mode_struct_w (item)
		ensure
			display_mode_width_not_changed: width = old width
			display_mode_height_not_changed: height = old height
			display_mode_refresh_rate_not_changed: refresh_rate = old refresh_rate
			display_mode_pixel_format_not_changed: pixel_format ~ old pixel_format
		end
	
feature -- Comparison

	frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_deep_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			shallow_implies_deep: standard_equal (a, b) implies Result
			both_or_none_void: (a = Void) implies (Result = (b = Void))
			same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b))
			symmetric: Result implies deep_equal (b, a)
		end

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))
		end

	frozen is_deep_equal alias "≡≡≡" (other: GAME_DISPLAY_MODE): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)
		end

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		do
			if a = Void then
				Result := b = Void
			else
				Result := b /= Void and then a.standard_is_equal (b)
			end
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))
		end

	frozen standard_is_equal alias "≜" (other: GAME_DISPLAY_MODE): BOOLEAN
			-- Is other attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
		end
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of other (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		end

	exists: BOOLEAN
			-- Is allocated memory still allocated?
			-- (from MEMORY_STRUCTURE)
		do
			Result := item /= default_pointer
		end

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of other?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		external
			"built_in"
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
		end
	
feature -- Duplication

	frozen clone (other: detachable ANY): like other
		obsolete "Use `twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- equal to other
			--
			-- For non-void other, clone calls copy;
			-- to change copying/cloning semantics, redefine copy.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.twin
			end
		ensure -- from ANY
			instance_free: class
			equal: Result ~ other
		end

	copy (other: GAME_DISPLAY_MODE)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_equal: Current ~ other
		end

	frozen deep_clone (other: detachable ANY): like other
		obsolete "Use `deep_twin' instead. [2017-05-31]"
			-- Void if other is void: otherwise, new object structure
			-- recursively duplicated from the one attached to other
			-- (from ANY)
		do
			if other /= Void then
				Result := other.deep_twin
			end
		ensure -- from ANY
			instance_free: class
			deep_equal: deep_equal (other, Result)
		end

	frozen deep_copy (other: GAME_DISPLAY_MODE)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		do
			copy (other.deep_twin)
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)
		end

	frozen deep_twin: GAME_DISPLAY_MODE
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)
		end

	frozen standard_clone (other: detachable ANY): like other
		obsolete "Use `standard_twin' instead. [2017-05-31]"
			-- Void if other is void; otherwise new object
			-- field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		do
			if other /= Void then
				Result := other.standard_twin
			end
		ensure -- from ANY
			instance_free: class
			equal: standard_equal (Result, other)
		end

	frozen standard_copy (other: GAME_DISPLAY_MODE)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		external
			"built_in"
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)
		end

	frozen standard_twin: GAME_DISPLAY_MODE
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)
		end

	frozen twin: GAME_DISPLAY_MODE
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
		end
	
feature -- Basic operations

	frozen as_attached: attached GAME_DISPLAY_MODE
		obsolete "Remove calls to this feature. [2017-05-31]"
			-- Attached version of Current.
			-- (Can be used during transitional period to convert
			-- non-void-safe classes to void-safe ones.)
			-- (from ANY)
		do
			Result := Current
		end

	frozen default: detachable GAME_DISPLAY_MODE
			-- Default value of object's type
			-- (from ANY)
		do
		end

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)
		do
		end

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		do
		ensure -- from ANY
			instance_free: class
		end
	
feature -- Implementation

	structure_size: INTEGER_32
			-- Size to allocate (in bytes).
		do
			Result := {GAME_SDL_EXTERNAL}.c_sizeof_sdl_display_mode
		ensure -- from MEMORY_STRUCTURE
			is_class: class
			positive_result: Result > 0
		end
	
feature {NONE} -- Implementation

	clear_error
			-- Remove error pending in Current
			-- (from GAME_SDL_ANY)
		require -- from  GAME_ERROR_MANAGER
			True
		do
			{GAME_SDL_EXTERNAL}.sdl_clearerror
			Precursor {GAME_ERROR_MANAGER}
			is_manual_error := False
		ensure -- from GAME_ERROR_MANAGER
			no_error: not has_error
		ensure then -- from GAME_SDL_ANY
			no_error: not is_manual_error
		end

	disable_print_on_error
			-- Desactive the print_on_error functionnality.
			-- (from GAME_ERROR_MANAGER)
		do
			Print_on_error_internal.put (False)
		end

	enable_print_on_error
			-- Active the print_on_error functionnality.
			-- (from GAME_ERROR_MANAGER)
		do
			Print_on_error_internal.put (True)
		end

	internal_item: POINTER
			-- Pointer holding value when shared.
			-- (from MEMORY_STRUCTURE)

	is_manual_error: BOOLEAN
			-- Is the current pending error is a manual error (using manual_error as message)
			-- (from GAME_SDL_ANY)

	manage_error_boolean (a_boolean: BOOLEAN; a_message: READABLE_STRING_GENERAL)
			-- Create an error if a_boolean is false.
			-- If there is an error, append a_message to the error message
			-- on the SDL2 library
			-- (from GAME_SDL_ANY)
		do
			if not a_boolean then
				if Print_on_error_internal.item then
					Io.Error.put_string (a_message.to_string_8 + "%N");
					Io.Error.put_string (last_error.to_string_8 + "%N")
				end
				has_error := True
			end
		ensure -- from GAME_SDL_ANY
				not a_boolean implies has_error
		end

	manage_error_code (a_error_code: INTEGER_32; a_message: READABLE_STRING_GENERAL)
			-- If needed create an error depending of the error code a_code.
			-- If there is an error, append a_message to the error message
			-- on the SDL2 library
			-- (from GAME_SDL_ANY)
		do
			if a_error_code < 0 then
				if Print_on_error_internal.item then
					Io.Error.put_string (a_message.to_string_8 + "%N");
					Io.Error.put_string (last_error.to_string_8 + "%N")
				end
				has_error := True
			end
		end

	manage_error_pointer (a_pointer: POINTER; a_message: READABLE_STRING_GENERAL)
			-- Create an error if a_pointer is not valid.
			-- If there is an error, append a_message to the error message
			-- on the SDL2 library
			-- (from GAME_SDL_ANY)
		do
			if a_pointer.is_default_pointer then
				if Print_on_error_internal.item then
					Io.Error.put_string (a_message.to_string_8 + "%N");
					Io.Error.put_string (last_error.to_string_8 + "%N")
				end
				has_error := True
			end
		ensure -- from GAME_SDL_ANY
				a_pointer.is_default_pointer implies has_error
		end

	managed_pointer: detachable MANAGED_POINTER
			-- Hold memory area in a managed way.
			-- (from MEMORY_STRUCTURE)

	manual_error: detachable READABLE_STRING_GENERAL
			-- The specific message for the last error
			-- (from GAME_ERROR_MANAGER)

	print_on_error: BOOLEAN
			-- When an error occured, the library will print
			-- informations about the error on the error console
			-- output (default is True).
			-- (from GAME_ERROR_MANAGER)
		do
			Result := Print_on_error_internal.item
		end

	Print_on_error_internal: CELL [BOOLEAN]
			-- True when an error occured,
			-- The library will print it right away.
			-- (from GAME_ERROR_MANAGER)
		once ("PROCESS")
			create Result.put (True)
		end

	put_manual_error (a_general_message, a_specific_error: READABLE_STRING_GENERAL)
			-- Create an error using a_general_error for the debug information
			-- and a_specific_error for the lasting information
			-- (from GAME_SDL_ANY)
		do
			is_manual_error := True
			Precursor {GAME_ERROR_MANAGER} (a_general_message, a_specific_error)
		ensure -- from GAME_ERROR_MANAGER
				has_error
		end

	set_print_on_error (a_value: BOOLEAN)
			-- Assign to print_on_error the value of a_value
			-- (from GAME_ERROR_MANAGER)
		do
			if a_value then
				enable_print_on_error
			else
				disable_print_on_error
			end
		ensure -- from GAME_ERROR_MANAGER
			is_assign: print_on_error ~ a_value
		end
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		once
			create Result;
			Result.set_output_default
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void
		end

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		local
			s: READABLE_STRING_8
		do
			if attached o then
				s := o.out
				if attached {READABLE_STRING_32} s as s32 then
					Io.put_string_32 (s32)
				elseif attached {READABLE_STRING_8} s as s8 then
					Io.put_string (s8)
				else
					Io.put_string_32 (s.as_string_32)
				end
			end
		ensure -- from ANY
			instance_free: class
		end

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		external
			"built_in"
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
		end
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		once
			create Result
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
		end
	
feature {NONE} -- Retrieval

	frozen internal_correct_mismatch
			-- Called from runtime to perform a proper dynamic dispatch on correct_mismatch
			-- from MISMATCH_CORRECTOR.
			-- (from ANY)
		local
			l_msg: STRING_32
			l_exc: EXCEPTIONS
		do
			if attached {MISMATCH_CORRECTOR} Current as l_corrector then
				l_corrector.correct_mismatch
			else
				create l_msg.make_from_string ("Mismatch: ".as_string_32)
				create l_exc;
				l_msg.append (generating_type.name_32);
				l_exc.raise_retrieval_exception (l_msg)
			end
		end
	
invariant
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

		-- from MEMORY_STRUCTURE
	managed_pointer_valid: not shared implies managed_pointer /= Void
	internal_item_valid: shared implies internal_item /= default_pointer

end -- class GAME_DISPLAY_MODE

Generated by ISE EiffelStudio