Automatic generation produced by ISE Eiffel
note description: "[ Objects creating directories and files in a system test set environment. ]" date: "$Date: 2020-05-19 06:46:56 -0800 (Tue, 19 May 2020) $" revision: "$Revision: 104271 $" class interface EQA_FILE_SYSTEM create make (an_asserter: like asserter) -- Initialize Current. -- -- an_asserter: Asserter used to raise an exception to report unexpected behaviour. require an_asserter_attached: an_asserter /= Void feature -- Access asserter: EQA_ASSERTIONS -- Asserter used to raise an exception to report unexpected behaviour. generating_type: TYPE [detachable EQA_FILE_SYSTEM] -- 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 -- 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: EQA_FILE_SYSTEM): 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: EQA_FILE_SYSTEM): 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: EQA_FILE_SYSTEM): 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: EQA_FILE_SYSTEM) -- 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: EQA_FILE_SYSTEM) -- 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: EQA_FILE_SYSTEM -- 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: EQA_FILE_SYSTEM) -- 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: EQA_FILE_SYSTEM -- 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: EQA_FILE_SYSTEM -- 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 EQA_FILE_SYSTEM -- 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 -- Basic delete_directory_tree (a_dir_name: READABLE_STRING_GENERAL) -- Try to delete the directory tree rooted at -- a_dir_name. Ignore any errors require directory_not_void: a_dir_name /= Void feature -- Command copy_file (a_src: FILE; a_env: EQA_ENVIRONMENT; a_dest: FILE; a_substitute: BOOLEAN) -- Append lines of file a_src, with environment -- variables substituted according to a_env (but -- only if substitute is true) to file a_dest. require source_not_void: a_src /= Void destination_not_void: a_dest /= Void environment_not_void: a_env /= Void source_is_closed: a_src.is_closed destination_is_closed: a_dest.is_closed feature -- Constants Source_directory_key: STRING_32 = "SOURCE_DIRECTORY" Target_directory_key: STRING_32 = "EQA_TARGET_DIRECTORY" 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 feature -- Query: Content executable_file_exists (s: detachable READABLE_STRING_GENERAL): detachable STRING_32 -- If file s does not exist or is not a file or -- is not executable, string describing the -- problem. Void otherwise has_same_content_as_path (a_first_path, a_second_path: EQA_SYSTEM_PATH): BOOLEAN -- Do target files for given paths have the same content? -- -- a_first: Relative path of first file. -- a_second: Relative path of second file. -- Result: True if both files existed and are readable and have identical content, False -- otherwise -- -- Note: if files do not exist or are not readable an exception is raised. require a_first_path_attached: a_first_path /= Void a_first_path_not_empty: not a_first_path.is_empty a_second_path_attached: a_second_path /= Void a_second_path_not_empty: not a_second_path.is_empty has_same_content_as_string (a_path: EQA_SYSTEM_PATH; a_string: READABLE_STRING_8): BOOLEAN -- Does target file for path have same content as given string? -- -- a_path: Path relative to target_directory of file -- a_string: String to be compared with content of file -- Result: True if file has same content as a_string, False otherwise -- -- Note: if file does not exists or is not readable an exception is raised. require a_path_attached: a_path /= Void a_path_not_empty: not a_path.is_empty a_string_attached: a_string /= Void feature -- Query: Path build_path (a_dir: READABLE_STRING_GENERAL; a_path: detachable EQA_SYSTEM_PATH): STRING_32 -- Build an absolute path name given a base directory and an optional path -- -- a_dir: A base dir in form of an absolute path. -- a_path: A relative path to append to a_dir. -- Result: Absolute path that results from appending items in a_path to a_dir require a_dir_attached: a_dir /= Void a_dir_not_empty: not a_dir.is_empty ensure result_attached: Result /= Void build_path_from_key (a_key: READABLE_STRING_GENERAL; a_path: detachable EQA_SYSTEM_PATH): STRING_32 -- Build an absolte path name given the key of an defined absolte path -- -- Note: will raise exception if value for a_key is not defined. -- -- a_key: Key for which an absolute base dir is defined in {EQA_ENVIRONMENT} -- a_path: An optional relative path to append to the resulting path. -- Result: Absolute path that results from appending items in a_path to base dir. require a_key_attached: a_key /= Void a_key_not_empty: not a_key.is_empty ensure result_attached: Result /= Void build_source_path (a_path: detachable EQA_SYSTEM_PATH): STRING_32 -- Build the actual path name relative to the source directory for given path -- -- Note: will raise exception if {EQA_TEST_SET}.source_path_key is not defined. -- -- a_path: Optional path for which path name should be built. -- Result: Path name relative to source directory. ensure result_attached: Result /= Void build_target_path (a_path: detachable EQA_SYSTEM_PATH): STRING_32 -- Build the actual path name relative to the target directory for given path. -- -- Note: will raise exception if {EQA_TEST_SET}.target_path_key is not defined. -- -- a_path: Optional path for which path name should be built -- Result: Path name relative to target directory. ensure result_attached: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, 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 EQA_FILE_SYSTEM -- Generated by Eiffel Studio --
For more details: eiffel.org