note
	description: "[
		Constants used for signal handling.
		This class may be used as ancestor by classes needing its facilities.
	]"
	library: "Free implementation of ELKS library"
	status: "See notice at end of class."
	legal: "See notice at end of class."
	date: "$Date: 2018-04-28 20:47:11 +0000 (Sat, 28 Apr 2018) $"
	revision: "$Revision: 101695 $"

class 
	UNIX_SIGNALS

create 
	default_create

feature {NONE} -- Initialization

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

	generating_type: TYPE [detachable UNIX_SIGNALS]
			-- 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

	is_defined (sig: INTEGER_32): BOOLEAN
			-- Is sig a signal defined for this platform?
		external
			"C use %"eif_sig.h%""
		alias
			"esigdefined"
		ensure
			instance_free: class
		end

	is_ignored (sig: INTEGER_32): BOOLEAN
			-- Is sig currently set to be ignored?
		do
			Result := not is_caught (sig)
		ensure
			instance_free: class
		end

	meaning (sig: INTEGER_32): detachable STRING_8
			-- A message in English describing what sig is
		do
			if is_defined (sig) then
				create Result.make_from_c (c_signal_name (sig))
			end
		ensure
			instance_free: class
		end

	Sigabrt: INTEGER_32
			-- Code for Abort signal
		once
			Result := c_signal_map (6)
		ensure
			instance_free: class
		end

	Sigalrm: INTEGER_32
			-- Code for Alarm clock signal
		once
			Result := c_signal_map (15)
		ensure
			instance_free: class
		end

	Sigbus: INTEGER_32
			-- Code for Bus error signal
		once
			Result := c_signal_map (11)
		ensure
			instance_free: class
		end

	Sigchld: INTEGER_32
			-- Code for Death of a child signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (19)
		ensure
			instance_free: class
		end

	Sigcld: INTEGER_32
			-- Code for Death of a child signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (20)
		ensure
			instance_free: class
		end

	Sigcont: INTEGER_32
			-- Code for Continue after stop signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (37)
		ensure
			instance_free: class
		end

	Sigemt: INTEGER_32
			-- Code for EMT instruction signal
		once
			Result := c_signal_map (8)
		ensure
			instance_free: class
		end

	Sigfpe: INTEGER_32
			-- Code for Floating point exception signal
		once
			Result := c_signal_map (9)
		ensure
			instance_free: class
		end

	Sighup: INTEGER_32
			-- Code for Hangup signal
		once
			Result := c_signal_map (1)
		ensure
			instance_free: class
		end

	Sigill: INTEGER_32
			-- Code for Illegal instruction signal
		once
			Result := c_signal_map (4)
		ensure
			instance_free: class
		end

	Sigint: INTEGER_32
			-- Code for Interrupt signal
		once
			Result := c_signal_map (2)
		ensure
			instance_free: class
		end

	Sigio: INTEGER_32
			-- Code for Pending I/O on a descriptor signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (21)
		ensure
			instance_free: class
		end

	Sigiot: INTEGER_32
			-- Code for IOT instruction signal
		once
			Result := c_signal_map (7)
		ensure
			instance_free: class
		end

	Sigkill: INTEGER_32
			-- Code for Terminator signal
		once
			Result := c_signal_map (10)
		ensure
			instance_free: class
		end

	Siglost: INTEGER_32
			-- Code for Resource lost signal
		once
			Result := c_signal_map (35)
		ensure
			instance_free: class
		end

	Sigphone: INTEGER_32
			-- Code for Line status change signal
		once
			Result := c_signal_map (34)
		ensure
			instance_free: class
		end

	Sigpipe: INTEGER_32
			-- Code for Broken pipe signal
		once
			Result := c_signal_map (14)
		ensure
			instance_free: class
		end

	Sigpoll: INTEGER_32
			-- Code for Selectable event pending signal
		once
			Result := c_signal_map (22)
		ensure
			instance_free: class
		end

	Sigprof: INTEGER_32
			-- Code for Profiling timer alarm signal
		once
			Result := c_signal_map (31)
		ensure
			instance_free: class
		end

	Sigpwr: INTEGER_32
			-- Code for Power-fail signal
		once
			Result := c_signal_map (30)
		ensure
			instance_free: class
		end

	Sigquit: INTEGER_32
			-- Code for Quit signal
		once
			Result := c_signal_map (3)
		ensure
			instance_free: class
		end

	Sigsegv: INTEGER_32
			-- Code for Segmentation violation signal
		once
			Result := c_signal_map (12)
		ensure
			instance_free: class
		end

	Sigstop: INTEGER_32
			-- Code for Stop signal
		once
			Result := c_signal_map (25)
		ensure
			instance_free: class
		end

	Sigsys: INTEGER_32
			-- Code for Bad argument to system call signal
		once
			Result := c_signal_map (13)
		ensure
			instance_free: class
		end

	Sigterm: INTEGER_32
			-- Code for Software termination signal
		once
			Result := c_signal_map (16)
		ensure
			instance_free: class
		end

	Sigtrap: INTEGER_32
			-- Code for Trace trap signal
		once
			Result := c_signal_map (5)
		ensure
			instance_free: class
		end

	Sigtstp: INTEGER_32
			-- Code for Stop from tty signal
		once
			Result := c_signal_map (26)
		ensure
			instance_free: class
		end

	Sigttin: INTEGER_32
			-- Code for Tty input from background signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (23)
		ensure
			instance_free: class
		end

	Sigttou: INTEGER_32
			-- Code for Tty output from background signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (24)
		ensure
			instance_free: class
		end

	Sigurg: INTEGER_32
			-- Code for Urgent condition on socket signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (36)
		ensure
			instance_free: class
		end

	Sigusr1: INTEGER_32
			-- Code for User-defined signal #1
		once
			Result := c_signal_map (17)
		ensure
			instance_free: class
		end

	Sigusr2: INTEGER_32
			-- Code for User-defined signal #2
		once
			Result := c_signal_map (18)
		ensure
			instance_free: class
		end

	Sigvtalarm: INTEGER_32
			-- Code for Virtual time alarm signal
		once
			Result := c_signal_map (29)
		ensure
			instance_free: class
		end

	Sigwinch: INTEGER_32
			-- Code for Window size changed signal.
			-- Signal ignored by default
		once
			Result := c_signal_map (32)
		ensure
			instance_free: class
		end

	Sigwind: INTEGER_32
			-- Code for Window change signal
		once
			Result := c_signal_map (33)
		ensure
			instance_free: class
		end

	Sigxcpu: INTEGER_32
			-- Code for Cpu time limit exceeded signal
		once
			Result := c_signal_map (27)
		ensure
			instance_free: class
		end

	Sigxfsz: INTEGER_32
			-- Code for File size limit exceeded signal
		once
			Result := c_signal_map (28)
		ensure
			instance_free: class
		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: UNIX_SIGNALS): 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: UNIX_SIGNALS): 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: UNIX_SIGNALS): 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

	signal: INTEGER_32
			-- Code of last signal
		external
			"C use %"eif_sig.h%""
		alias
			"esignum"
		ensure
			instance_free: class
		end
	
feature -- Status setting

	catch (sig: INTEGER_32)
			-- Make sure that future occurrences of sig
			-- will be treated as exceptions.
			-- (This is the default for all signals.)
			-- No effect if signal not defined.
		external
			"C use %"eif_sig.h%""
		alias
			"esigcatch"
		ensure
			instance_free: class
		end

	ignore (sig: INTEGER_32)
			-- Make sure that future occurrences of sig
			-- will be ignored. (This is not the default.)
			-- No effect if signal not defined.
		external
			"C use %"eif_sig.h%""
		alias
			"esigignore"
		ensure
			instance_free: class
		end

	reset_all_default
			-- Make sure that all exceptions will lead to their
			-- default handling.
		external
			"C use %"eif_sig.h%""
		alias
			"esigresall"
		ensure
			instance_free: class
		end

	reset_default (sig: INTEGER_32)
			-- Make sure that exception of code code will lead
			-- to its default action.
		require
				is_defined (sig)
		external
			"C use %"eif_sig.h%""
		alias
			"esigresdef"
		ensure
			instance_free: class
		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: UNIX_SIGNALS)
			-- 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: UNIX_SIGNALS)
			-- 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: UNIX_SIGNALS
			-- 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: UNIX_SIGNALS)
			-- 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: UNIX_SIGNALS
			-- 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: UNIX_SIGNALS
			-- 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 UNIX_SIGNALS
		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 UNIX_SIGNALS
			-- 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

	c_signal_map (i: INTEGER_32): INTEGER_32
		external
			"C use %"eif_sig.h%""
		alias
			"esigmap"
		ensure
			instance_free: class
		end

	c_signal_name (i: INTEGER_32): POINTER
		external
			"C use %"eif_sig.h%""
		alias
			"esigname"
		ensure
			instance_free: class
		end

	is_caught (sig: INTEGER_32): BOOLEAN
			-- Is sig currently set to be caught?
		external
			"C use %"eif_sig.h%""
		alias
			"esigiscaught"
		ensure
			instance_free: class
		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)

note
	copyright: "Copyright (c) 1984-2018, 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 UNIX_SIGNALS

Generated by ISE EiffelStudio