note
	description: "An image from a custom package file."
	author: "Louis Marchand"
	date: "Thu, 02 Apr 2015 03:46:04 +0000"
	revision: "2.0"

class interface
	IMG_IMAGE_CPF

create 
	make (a_cpf: CPF_PACKAGE_FILE; a_cpf_index: INTEGER_32)
			-- make Current from the image in the custom package file a_cpf at a_cpf_index.
		require -- from CPF_RESSOURCE_MANAGER
			img_cpf_index_valid: a_cpf.is_readable and then a_cpf_index > 0 and then a_cpf_index <= a_cpf.sub_files_count

feature -- Access

	exists: BOOLEAN
			-- Is item valid memory pointer
			-- (from GAME_IMAGE)

	Game_library: GAME_LIBRARY_CONTROLLER
			-- The main controller of the game library
			-- (from GAME_LIBRARY_SHARED)

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

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

	has_ressource_error: BOOLEAN
			-- Has an error occured while opening Current
			-- (from GAME_RESSOURCE)

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

	is_bmp: BOOLEAN
			-- The internal library support BMP format and the file is a valid BMP file.

	is_cur: BOOLEAN
			-- The internal library support BMP format and the file is a valid CUR file.

	is_gif: BOOLEAN
			-- The internal library support GIF format and the file is a valid GIF file.

	is_ico: BOOLEAN
			-- The internal library support BMP format and the file is a valid ICO file.

	is_jpg: BOOLEAN
			-- The internal library support JPG format and the file is a valid JPG file.

	is_lbm: BOOLEAN
			-- The internal library support LBM format and the file is a valid LBM file.

	is_open: BOOLEAN
			-- Is Current has been properly opened
			-- (from GAME_RESSOURCE)

	is_openable: BOOLEAN
			-- Can Current be open
			-- (from IMG_IMAGE_FILE)
		require -- from  GAME_RESSOURCE
			True

	is_pcx: BOOLEAN
			-- The internal library support PCX format and the file is a valid PCX file.

	is_png: BOOLEAN
			-- The internal library support PNG format and the file is a valid PNG file.

	is_pnm: BOOLEAN
			-- The internal library support PNM format and the file is a valid PNM file.

	is_tif: BOOLEAN
			-- The internal library support TIF format and the file is a valid TIF file.

	is_xcf: BOOLEAN
			-- The internal library support XCF format and the file is a valid XCF file.

	is_xpm: BOOLEAN
			-- The internal library support XPM format and the file is a valid XPM file.

	is_xv: BOOLEAN
			-- The internal library support XV format and the file is a valid XV file.

	last_sdl_error: READABLE_STRING_GENERAL
			-- The last error generate by the library
			-- (from GAME_SDL_ANY)

	open
			-- Open Current
		require -- from GAME_RESSOURCE
			ressource_is_openable: is_openable
			ressource_is_not_open: not is_open and not has_ressource_error
		ensure -- from GAME_RESSOURCE
			ressource_is_open: is_open or has_ressource_error
		ensure then -- from GAME_IMAGE
			exists: not has_error implies exists
			is_open: not has_error implies is_open
	
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)
		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)

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

	frozen is_deep_equal alias "≡≡≡" (other: IMG_IMAGE_CPF): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		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)

	is_equal (other: IMG_IMAGE_CPF): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

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

	frozen standard_is_equal alias "≜" (other: IMG_IMAGE_CPF): 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
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
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

	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
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Duplication

	copy (other: IMG_IMAGE_CPF)
			-- 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)
		ensure -- from ANY
			is_equal: Current ~ other

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

	frozen deep_twin: IMG_IMAGE_CPF
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: IMG_IMAGE_CPF)
			-- 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)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

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

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

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

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

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

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

	last_error: READABLE_STRING_GENERAL
			-- The last error generate by the library
			-- (from IMG_ANY)
		require -- from  GAME_ERROR_MANAGER
			True
	
feature -- Implementation - Variable

	dispose
			-- Action to be executed just before garbage collection
			-- reclaims an object.
			-- Effect it in descendants to perform specific dispose
			-- actions. Those actions should only take care of freeing
			-- external resources; they should not perform remote calls
			-- on other objects since these may also be dead and reclaimed.
			-- (from IMG_IMAGE_FILE)
		require -- from  DISPOSABLE
			True
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			out_not_void: Result /= Void

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

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

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
	
invariant
		-- from GAME_IMAGE
	image_source_valid: is_open implies exists

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

		-- from CPF_RESSOURCE_MANAGER
	cpf_valid: cpf.is_readable
	cpf_index_valid: cpf_index > 0 and cpf_index <= cpf.sub_files_count

end -- class IMG_IMAGE_CPF

Generated by ISE EiffelStudio