note description: "[ Every high level events that are not attached to a specific component of the library (window, joystick, etc.) ]" author: "Louis Marchand" date: "Sat, 28 Feb 2015 19:01:23 +0000" revision: "2.0" deferred class GAME_COMMON_EVENTS feature {NONE} -- Initialization default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) do end feature -- Access clear -- Remove common library event. -- Note: does not clear other events like window events, joystick events, etc. To clear every events -- in the system, used GAME_LIBRARY_CONTROLLER.clear_all_events. local l_was_running: BOOLEAN do l_was_running := is_running if is_running then stop end quit_signal_actions_internal := Void iteration_actions_internal := Void joystick_founded_actions_internal := Void joystick_removed_actions_internal := Void joystick_found_actions_internal := Void joystick_remove_actions_internal := Void file_dropped_actions_internal := Void if l_was_running then run end ensure -- from GAME_EVENTS running_unchanged: is_running = old is_running end events_controller: GAME_EVENTS_CONTROLLER -- Manage every internal events -- (from GAME_EVENTS) deferred end file_dropped_actions: ACTION_SEQUENCE [NATURAL_32, READABLE_STRING_GENERAL] -- Called when the file (or any other string) filename is drag and drop on a GAME_WINDOW. -- The event is not enabled by default. Use events_controller.enable_file_dropped_event to enable it. require joystick_found_event_enabled: events_controller.is_joy_device_founded_event_enable do if attached file_dropped_actions_internal as la_on_file_drop_internal then Result := la_on_file_drop_internal else create Result if is_running then events_controller.file_dropped_actions.extend (file_dropped_actions_callback) end file_dropped_actions_internal := Result end end generating_type: TYPE [detachable GAME_COMMON_EVENTS] -- 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) is_running: BOOLEAN assign set_is_running -- Is Current active -- (from GAME_EVENTS) iteration_actions: ACTION_SEQUENCE [NATURAL_32] -- Called at each game loop do if attached iteration_actions_internal as la_on_iteration_internal then Result := la_on_iteration_internal else create Result if is_running then events_controller.iteration_actions.extend (iteration_actions_callback) end iteration_actions_internal := Result end end joystick_found_actions: ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Called when a new joystick has been founded -- Automatically added to GAME_LIBRARY_CONTROLLER.joysticks require joystick_found_event_enabled: events_controller.is_joy_device_founded_event_enable do if attached joystick_found_actions_internal as la_on_joystick_added_internal then Result := la_on_joystick_added_internal else create Result if is_running then events_controller.joy_device_founded_actions.extend (joystick_founded_actions_callback) end joystick_found_actions_internal := Result end end joystick_founded_actions: ACTION_SEQUENCE [NATURAL_32, INTEGER_32] obsolete "Use `joystick_found_actions' instead [2020-03-30]" -- Called when a new joystick has been founded -- To get the new joystick, call GAME_LIBRARY_CONTROLLER.refresh_joysticks, -- then use the GAME_LIBRARY_CONTROLLER.joysticks.at(joystick_id) require joystick_found_event_enabled: events_controller.is_joy_device_founded_event_enable do if attached joystick_founded_actions_internal as la_on_joystick_added_internal then Result := la_on_joystick_added_internal else create Result if is_running then events_controller.joy_device_founded_actions.extend (joystick_founded_actions_callback) end joystick_founded_actions_internal := Result end end joystick_remove_actions: ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Called when a new joystick has been removed -- The joystick will be removed from GAME_LIBRARY_CONTROLLER.joysticks after the -- calls of this feature. require joystick_remove_event_enabled: events_controller.is_joy_device_removed_event_enable do if attached joystick_remove_actions_internal as la_on_joystick_removed_internal then Result := la_on_joystick_removed_internal else create Result if is_running then events_controller.joy_device_removed_actions.extend (joystick_removed_actions_callback) end joystick_remove_actions_internal := Result end end joystick_removed_actions: ACTION_SEQUENCE [NATURAL_32, INTEGER_32] obsolete "Use `joystick_remove_actions' instead [2020-03-30]" -- Called when a new joystick has been removed -- The joystick will be removed from GAME_LIBRARY_CONTROLLER.joysticks after the -- calls of this feature. require joystick_remove_event_enabled: events_controller.is_joy_device_removed_event_enable do if attached joystick_removed_actions_internal as la_on_joystick_removed_internal then Result := la_on_joystick_removed_internal else create Result if is_running then events_controller.joy_device_removed_actions.extend (joystick_removed_actions_callback) end joystick_removed_actions_internal := Result 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 quit_signal_actions: ACTION_SEQUENCE [NATURAL_32] -- When the application receive a quit signal. require quit_event_enabled: events_controller.is_quit_signal_event_enable do if attached quit_signal_actions_internal as la_on_quit_signal_internal then Result := la_on_quit_signal_internal else create Result if is_running then events_controller.quit_signal_actions.extend (quit_signal_actions_callback) end quit_signal_actions_internal := Result end end run -- Put Current active. require -- from GAME_EVENTS run_not_already_running: not is_running do is_running := True if attached quit_signal_actions_internal as la_on_quit_signal_internal then events_controller.quit_signal_actions.extend (quit_signal_actions_callback) end if attached iteration_actions_internal as la_on_iteration_internal then events_controller.iteration_actions.extend (iteration_actions_callback) end if attached file_dropped_actions_internal as la_on_file_drop_internal then events_controller.file_dropped_actions.extend (file_dropped_actions_callback) end ensure -- from GAME_EVENTS is_running: is_running end set_is_running (a_value: BOOLEAN) -- Assign to is_running the value of a_value -- (from GAME_EVENTS) do if a_value then run else stop end ensure -- from GAME_EVENTS is_assign: is_running ~ a_value end stop -- Put Current innactive. require -- from GAME_EVENTS stop_is_running: is_running do is_running := False; events_controller.quit_signal_actions.prune_all (quit_signal_actions_callback); events_controller.iteration_actions.prune_all (iteration_actions_callback); events_controller.file_dropped_actions.prune_all (file_dropped_actions_callback) ensure -- from GAME_EVENTS is_stopped: not is_running 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_COMMON_EVENTS): 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 is_equal (other: GAME_COMMON_EVENTS): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void external "built_in" ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result 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_COMMON_EVENTS): 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 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_COMMON_EVENTS) -- 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_COMMON_EVENTS) -- 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_COMMON_EVENTS -- 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_COMMON_EVENTS) -- 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_COMMON_EVENTS -- 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_COMMON_EVENTS -- 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_COMMON_EVENTS 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_COMMON_EVENTS -- 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 {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 file_dropped_actions_callback: PROCEDURE [NATURAL_32, READABLE_STRING_GENERAL] -- Internal callback of the file dropped event file_dropped_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32, READABLE_STRING_GENERAL] -- Internal representation of the file drop event is_manual_error: BOOLEAN -- Is the current pending error is a manual error (using manual_error as message) -- (from GAME_SDL_ANY) iteration_actions_callback: PROCEDURE [NATURAL_32] -- Internal callback of the iteration event iteration_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32] -- Internal representation of the iteration event joystick_found_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Internal representation of the joystick founded event joystick_founded_actions_callback: PROCEDURE [NATURAL_32, INTEGER_32] -- Internal callback of the joystick founded event joystick_founded_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32, INTEGER_32] -- Internal representation of the joystick founded event joystick_remove_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32, GAME_JOYSTICK] -- Internal representation of the joystick removed event joystick_removed_actions_callback: PROCEDURE [NATURAL_32, INTEGER_32] -- Internal callback of the joystick removed event joystick_removed_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32, INTEGER_32] -- Internal representation of the joystick removed event 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 manage_joystick_founded_callback (a_timestamp: NATURAL_32; a_joystick_id: INTEGER_32) -- Used to manage joystick_founded_actions_callback deferred end manage_joystick_removed_callback (a_timestamp: NATURAL_32; a_joystick_id: INTEGER_32) -- Used to manage joystick_removed_actions_callback deferred end 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 quit_signal_actions_callback: PROCEDURE [NATURAL_32] -- Internal callback of the quit signal event quit_signal_actions_internal: detachable ACTION_SEQUENCE [NATURAL_32] -- Internal representation of the quit signal event 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 {NONE} -- Initialisation make -- Initialization of Current do file_dropped_actions_callback := agent (a_timestamp: NATURAL_32; a_filename: READABLE_STRING_GENERAL) do file_dropped_actions.call ([a_timestamp, a_filename]) end joystick_founded_actions_callback := agent (a_timestamp: NATURAL_32; a_joystick_id: INTEGER_32) do manage_joystick_founded_callback (a_timestamp, a_joystick_id) end joystick_removed_actions_callback := agent (a_timestamp: NATURAL_32; a_joystick_id: INTEGER_32) do manage_joystick_removed_callback (a_timestamp, a_joystick_id) end quit_signal_actions_callback := agent (a_timestamp: NATURAL_32) do quit_signal_actions.call ([a_timestamp]) end iteration_actions_callback := agent (a_timestamp: NATURAL_32) do iteration_actions.call ([a_timestamp]) end Precursor {GAME_EVENTS} ensure -- from GAME_EVENTS make_event_is_running: is_running 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 out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) do Result := tagged_out ensure -- from ANY out_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) end -- class GAME_COMMON_EVENTS
Generated by ISE EiffelStudio