Automatic generation produced by ISE Eiffel
note description: "Directories, in the Unix sense, with creation and exploration features" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2017-03-23 11:18:26 -0800 (Thu, 23 Mar 2017) $" revision: "$Revision: 100033 $" class interface DIRECTORY create make (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn. require string_exists: dn /= Void ensure name_set: internal_name = dn make_with_path (a_path: PATH) -- Create file object with a_path as path. require a_path_attached: a_path /= Void make_with_name (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn. require string_exists: dn /= Void ensure name_set: internal_name = dn make_open_read (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn and open it for reading. require string_exists: dn /= Void ensure name_set: internal_name = dn feature -- Initialization make (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn. require string_exists: dn /= Void ensure name_set: internal_name = dn make_open_read (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn and open it for reading. require string_exists: dn /= Void ensure name_set: internal_name = dn make_with_name (dn: READABLE_STRING_GENERAL) -- Create directory object for directory -- of name dn. require string_exists: dn /= Void ensure name_set: internal_name = dn make_with_path (a_path: PATH) -- Create file object with a_path as path. require a_path_attached: a_path /= Void feature -- Access change_name (new_name: READABLE_STRING_GENERAL) -- Change directory name to new_name. require new_name_not_void: new_name /= Void directory_exists: exists ensure name_changed: internal_name = new_name close -- Close directory. require is_open: not is_closed generating_type: TYPE [detachable DIRECTORY] -- 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_entry (entry_name: READABLE_STRING_GENERAL): BOOLEAN -- Has directory the entry entry_name? require string_exists: entry_name /= Void open_read -- Open directory for reading. path: PATH -- Associated path of Current. ensure entry_not_empty: not Result.is_empty readentry -- Read next directory entry -- make result available in `lastentry`. -- Make result Void if all entries have been read. require is_opened: not is_closed rename_path (new_name: PATH) -- Change directory name to new_name. require new_name_not_void: new_name /= Void new_name_not_empty: not new_name.is_empty file_exists: exists ensure name_changed: internal_name = new_name.name start -- Go to first entry of directory. require is_opened: not is_closed feature -- Measurement count: INTEGER_32 -- Number of entries in directory. require directory_exists: exists 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: DIRECTORY): 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: DIRECTORY): 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: DIRECTORY): 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 exists: BOOLEAN -- Does the directory exist? is_closed: BOOLEAN -- Is current directory closed? is_empty: BOOLEAN -- Is directory empty? require directory_exists: exists is_executable: BOOLEAN -- Is the directory executable? require directory_exists: exists is_readable: BOOLEAN -- Is the directory readable? require directory_exists: exists is_writable: BOOLEAN -- Is the directory writable? require directory_exists: exists last_entry_32: detachable STRING_32 -- Last Unicode entry read by `readentry` if any. last_entry_8: detachable STRING_8 -- Raw byte sequence of the last found entry if this entry cannot be -- expressed with Unicode characters. This is useful -- when handling a file that is not a valid UTF-8 sequence on Unix. 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 -- Removal delete -- Delete directory if empty. require directory_exists: exists empty_directory: is_empty delete_content -- Delete all files located in current directory and its -- subdirectories. require directory_exists: exists delete_content_with_action (action: detachable PROCEDURE [LIST [READABLE_STRING_GENERAL]]; is_cancel_requested: detachable FUNCTION [BOOLEAN]; file_number: INTEGER_32) -- Delete all files located in current directory and its -- subdirectories. -- -- action is called each time at most file_number files has -- been deleted and before the function exits. If a_file_number -- is non-positive, action is not called. -- action may be set to Void if you don't need it. -- -- Same for is_cancel_requested. -- Make it return True to cancel the operation. -- is_cancel_requested may be set to Void if you don't need it. require directory_exists: exists valid_file_number: file_number >= 0 dispose -- Ensure this medium is closed when garbage collected. recursive_delete -- Delete directory, its files and its subdirectories. require directory_exists: exists recursive_delete_with_action (action: detachable PROCEDURE [LIST [READABLE_STRING_GENERAL]]; is_cancel_requested: detachable FUNCTION [BOOLEAN]; file_number: INTEGER_32) -- Delete directory, its files and its subdirectories. -- -- action is called each time at most file_number files has -- been deleted and before the function exits. If a_file_number -- is non-positive, action is not called. require directory_exists: exists feature -- Conversion entries: ARRAYED_LIST [PATH] -- Entries (i.e. just the file or directory name) of current directory, -- in sequential format, in a platform specific order. linear_representation_32: ARRAYED_LIST [STRING_32] -- The entries, in sequential format. resolved_entries: ARRAYED_LIST [PATH] -- Entries of current directory resolved in the context of current directory (i.e. the path -- of the current directory appended with the entry) in sequential format, in a platform specific -- order. -- Compared to `entries`, it removes the need for callers to build the full path of the entry -- using Current. feature -- Duplication copy (other: DIRECTORY) -- 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: DIRECTORY) -- 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: DIRECTORY -- 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: DIRECTORY) -- 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: DIRECTORY -- 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: DIRECTORY -- 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 DIRECTORY -- 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 -- Creation create_dir -- Create a physical directory. require physical_not_exists: not exists recursive_create_dir -- Create the directory recursively. -- -- Ex: if /temp/ exists but not /temp/test, then trying -- to create /temp/test/toto will create /temp/test -- and then /temp/test/toto. ensure physical_exists: exists 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 name_attached: attached internal_name -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2017, 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 DIRECTORY -- Generated by Eiffel Studio --
For more details: eiffel.org