note
	description: "project application root class"
	date: "$Date$"
	revision: "$Revision$"

class interface
	ROOT

create 
	make
			-- Run application

feature -- Access

	argument (i: INTEGER_32): STRING_8
			-- i-th argument of command that started system execution
			-- (the command name if i = 0)
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			index_large_enough: i >= 0
			index_small_enough: i <= argument_count
		ensure -- from ARGUMENTS
			instance_free: class
			argument_not_void: Result /= Void

	Argument_array: ARRAY [STRING_8]
			-- Array containing command name (position 0) and arguments
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class
			argument_array_not_void: Result /= Void
			argument_array_compare_objects: Result.object_comparison

	Command_line: STRING_8
			-- Total command line
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class
				Result.count >= Command_name.count

	Command_name: STRING_8
			-- Name of command that started system execution
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class
			definition: Result ~ argument (0)

	generating_type: TYPE [detachable ROOT]
			-- 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
	
feature -- Measurement

	argument_count: INTEGER_32
			-- Number of arguments given to command that started
			-- system execution (command name does not count)
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class
			argument_count_positive: Result >= 0
	
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 (other: ROOT): 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: ROOT): 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 (other: ROOT): 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

	coalesced_character_option_value (o: CHARACTER_8): detachable STRING_8
			-- The value, if any, specified for character option o on
			-- the command line.
			-- Defined as follows (where 'X' is the current 'option_sign' and
			-- 'xx' is an arbitrary, possibly empty sequence of characters):
			--   val if command line includes an argument of the form Xxxoval
			--	   (this may be an empty string if argument is just Xxxo).
			--   Void otherwise.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			o_non_null: o /= '%U'
		ensure -- from ARGUMENTS
			instance_free: class

	coalesced_word_option_value (opt: STRING_8): detachable STRING_8
			-- The value, if any, specified for word option opt on the
			-- command line.
			-- Defined as follows (where X is the current Option_sign):
			--   val if command line includes an argument of the form Xoptval
			--	   (this may be an empty string if argument is just Xopt).
			--   Void otherwise.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			opt_non_void: opt /= Void
			opt_meaningful: not opt.is_empty
		ensure -- from ARGUMENTS
			instance_free: class

	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

	index_of_beginning_with_word_option (opt: STRING_8): INTEGER_32
			-- Does command line specify argument beginning with word
			-- option opt and, if so, at what position?
			-- If one of the arguments in list of space-separated arguments
			-- is Xoptxx, where X is the current Option_sign, 'xx'
			-- is arbitrary, possibly empty sequence of characters,
			-- then index of this argument in list;
			-- else 0.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			opt_non_void: opt /= Void
			opt_meaningful: not opt.is_empty
		ensure -- from ARGUMENTS
			instance_free: class

	index_of_character_option (o: CHARACTER_8): INTEGER_32
			-- Does command line specify character option o and, if so,
			-- at what position?
			-- If one of the space-separated arguments is of the form Xxxoyy,
			-- where X is the current Option_sign, xx and yy
			-- are arbitrary, possibly empty sequences of characters,
			-- then index of this argument in list of arguments;
			-- else 0.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			o_non_null: o /= '%U'
		ensure -- from ARGUMENTS
			instance_free: class

	index_of_word_option (opt: STRING_8): INTEGER_32
			-- Does command line specify word option opt and, if so,
			-- at what position?
			-- If one of the arguments in list of space-separated arguments
			-- is Xopt, where X is the current Option_sign,
			-- then index of this argument in list;
			-- else 0.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			opt_non_void: opt /= Void
			opt_meaningful: not opt.is_empty
		ensure -- from ARGUMENTS
			instance_free: class

	Option_sign: CHARACTER_8_REF
			-- The character used to signal options on the command line.
			-- This can be '%U' if no sign is necessary for the argument
			-- to be an option
			-- Default is '-'
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class

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

	separate_character_option_value (o: CHARACTER_8): detachable STRING_8
			-- The value, if any, specified after character option o on
			-- the command line.
			-- This is one of the following (where X is the current
			-- Option_sign, xx and 'yy' are arbitrary, possibly empty
			-- sequences of characters):
			--   val if command line includes two consecutive arguments
			--	   of the form Xxxoyy and val respectively.
			--   Empty string if command line includes argument Xxxoyy, which is
			--	   either last argument or followed by argument starting with X.
			--   Void if there is no argument of the form Xxxoyy.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			o_non_null: o /= '%U'
		ensure -- from ARGUMENTS
			instance_free: class

	separate_word_option_value (opt: STRING_8): detachable STRING_8
			-- The value, if any, specified after word option opt on the
			-- command line.
			-- This is one of the following (where X is the current Option_sign):
			--   val if command line includes two consecutive arguments
			--	   of the form Xopt and val respectively.
			--   Empty string if command line includes argument Xopt, which is
			--	   either last argument or followed by argument starting with X.
			--   Void if no Xopt argument.
			-- (from ARGUMENTS)
		require -- from ARGUMENTS
			opt_non_void: opt /= Void
			opt_meaningful: not opt.is_empty
		ensure -- from ARGUMENTS
			instance_free: class
	
feature -- Status setting

	set_option_sign (c: CHARACTER_8)
			-- Make c the option sign.
			-- Use'%U' if no sign is necessary for the argument to
			-- be an option
			-- (from ARGUMENTS)
		ensure -- from ARGUMENTS
			instance_free: class
	
feature -- Duplication

	copy (other: ROOT)
			-- 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: ROOT)
			-- 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: ROOT
			-- 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: ROOT)
			-- 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: ROOT
			-- 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: ROOT
			-- 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 ROOT
			-- 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 

	browser: BOOLEAN
			-- (from ES_TESTABLE)

	check_browser
			-- Run the browser on the generated HTML.
			-- (from ES_TESTABLE)

	curr_os_dir_separator: CHARACTER_8
			--  Return path separator for current OS.
			-- (from ES_TESTABLE)
		ensure -- from ES_TESTABLE
			separator_is_a_slash: Result = '/' or Result = '\'

	default_html_name: detachable STRING_8
			-- (from ES_TESTABLE)

	get_html_name: STRING_8
			-- Return the name of the default html for this unit test.
			-- (from ES_TESTABLE)

	number_of_tests: INTEGER_32
			-- (from ES_TESTABLE)

	number_passed_tests: INTEGER_32
			-- (from ES_TESTABLE)

	print_console_report
			-- Print a summary of all the test case results to the console.
			-- (from ES_TESTABLE)

	print_to_screen (message: STRING_8)
			-- Prints the message to the screen, handles both GUI and standard output.
			-- (from ES_TESTABLE)

	run_espec
			-- New feature instead of run_all.
			-- (from ES_TESTABLE)

	safe_put_string (message: STRING_8)
			-- Socket.putstring with exception handling.
			-- (from ES_TESTABLE)

	set_error_report (v: BOOLEAN)
			-- Show the contract violations if set to true.
			-- (from ES_TESTABLE)

	set_html_name (s: STRING_8)
			-- Set the output html name.
			-- (from ES_TESTABLE)

	show_browser
			-- Show the default browser.
			-- (from ES_TESTABLE)

	show_err: BOOLEAN
			-- (from ES_TESTABLE)

	show_errors
			-- Print error traces to the output.
			-- (from ES_TESTABLE)
	
feature -- Access: Cursor

	new_cursor: ITERATION_CURSOR [STRING_8]
			-- Fresh cursor associated with current structure
			-- (from ARGUMENTS)
		require -- from  ITERABLE
			True
		ensure -- from ITERABLE
			result_attached: Result /= Void
		ensure then -- from ARGUMENTS
			instance_free: class
	
feature -- Basic Operations

	add_suite (suite_test_class: ES_SUITE)
			-- Adds a suite of tests to the current suite.
			-- (from ES_SUITE)
		require -- from ES_SUITE
			suite_test_class_exists: suite_test_class /= Void

	add_test (unit_test_class: ES_TEST)
			-- Adds class level test unit_test_class to Current test suite
			-- use this feature to add your unit test classes to the suite.
			-- (from ES_SUITE)
		require -- from ES_SUITE
			unit_tests_class_exists: unit_test_class /= Void
	
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 ARGUMENTS
	argument_array_consistent: Argument_array ~ internal_argument_array

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

end -- class ROOT

Generated by ISE EiffelStudio