Automatic generation produced by ISE Eiffel
note description: "Obsolete internal file information, use FILE_INFO directly." library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2013-01-24 13:27:55 -0900 (Thu, 24 Jan 2013) $" revision: "$Revision: 92130 $" class interface UNIX_FILE_INFO create make -- Creation procedure -- (from FILE_INFO) ensure -- from FILE_INFO not_exists: not exists is_following_symlinks_set: is_following_symlinks feature -- Initialization make -- Creation procedure -- (from FILE_INFO) ensure -- from FILE_INFO not_exists: not exists is_following_symlinks_set: is_following_symlinks feature -- Access access_date: INTEGER_32 -- Date of last access -- (from FILE_INFO) require -- from FILE_INFO exists: exists buffered_file_info: SPECIAL [NATURAL_8] -- Special data zone. -- (from TO_SPECIAL) at alias "@" (i: INTEGER_32): NATURAL_8 assign put -- Entry at index i, if in index interval. -- Was declared in {TO_SPECIAL} as synonym of `item`. -- (from TO_SPECIAL) require -- from TO_SPECIAL valid_index: valid_index (i) change_date: INTEGER_32 -- Date of last status change -- (from FILE_INFO) require -- from FILE_INFO exists: exists date: INTEGER_32 -- Last modification date -- (from FILE_INFO) require -- from FILE_INFO exists: exists device: INTEGER_32 -- Device number on which inode resides -- (from FILE_INFO) require -- from FILE_INFO exists: exists device_type: INTEGER_32 -- Device type on which inode resides -- (from FILE_INFO) require -- from FILE_INFO exists: exists file_entry: detachable PATH -- Associated entry for Current. -- (from FILE_INFO) generating_type: TYPE [detachable UNIX_FILE_INFO] -- 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 group_id: INTEGER_32 -- GID of the file -- (from FILE_INFO) require -- from FILE_INFO exists: exists group_name: STRING_8 -- Name of the file group, if available from /etc/group. -- Otherwise, the GID -- (from FILE_INFO) require -- from FILE_INFO exists: exists inode: INTEGER_32 -- Inode number -- (from FILE_INFO) require -- from FILE_INFO exists: exists item alias "[]" (i: INTEGER_32): NATURAL_8 assign put -- Entry at index i, if in index interval. -- Was declared in {TO_SPECIAL} as synonym of `at`. -- (from TO_SPECIAL) require -- from TO_SPECIAL valid_index: valid_index (i) links: INTEGER_32 -- Number of links -- (from FILE_INFO) require -- from FILE_INFO exists: exists owner_name: STRING_8 -- Name of the file owner, if available from /etc/passwd. -- Otherwise, the UID -- (from FILE_INFO) require -- from FILE_INFO exists: exists protection: INTEGER_32 -- Protection mode of file (12 lower bits) -- (from FILE_INFO) require -- from FILE_INFO exists: exists size: INTEGER_32 -- File size, in bytes -- (from FILE_INFO) require -- from FILE_INFO exists: exists type: INTEGER_32 -- File type (4 bits, 12 lowest bits zeroed) -- (from FILE_INFO) require -- from FILE_INFO exists: exists user_id: INTEGER_32 -- UID of the file owner -- (from FILE_INFO) require -- from FILE_INFO 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: UNIX_FILE_INFO): 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: UNIX_FILE_INFO): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from FILE_INFO) 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: UNIX_FILE_INFO): 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 current file exists? -- (from FILE_INFO) is_access_executable: BOOLEAN -- Is file executable by real UID? -- (from FILE_INFO) require -- from FILE_INFO is_ready: is_ready is_access_owner: BOOLEAN -- Is file owned by real UID? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_access_readable: BOOLEAN -- Is file readable by real UID? -- (from FILE_INFO) require -- from FILE_INFO is_ready: is_ready is_access_writable: BOOLEAN -- Is file writable by real UID? -- (from FILE_INFO) require -- from FILE_INFO is_ready: is_ready is_block: BOOLEAN -- Is file a device block special file? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_character: BOOLEAN -- Is file a character block special file? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_device: BOOLEAN -- Is file a device? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_directory: BOOLEAN -- Is file a directory? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_executable: BOOLEAN -- Is file executable by effective UID? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_fifo: BOOLEAN -- Is file a named pipe? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_following_symlinks: BOOLEAN -- Does current follow symbolic links when retrieving properties? -- (from FILE_INFO) is_owner: BOOLEAN -- Is file owned by effective UID? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_plain: BOOLEAN -- Is file a plain file? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_readable: BOOLEAN -- Is file readable by effective UID? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_ready: BOOLEAN -- Is current ready to perform a query? -- (from FILE_INFO) is_setgid: BOOLEAN -- Is file setgid? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_setuid: BOOLEAN -- Is file setuid? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_socket: BOOLEAN -- Is file a named socket? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_sticky: BOOLEAN -- Is file sticky? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_symlink: BOOLEAN -- Is file a symbolic link? -- (from FILE_INFO) require -- from FILE_INFO exists: exists is_writable: BOOLEAN -- Is file writable by effective UID? -- (from FILE_INFO) require -- from FILE_INFO exists: exists 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)) valid_index (i: INTEGER_32): BOOLEAN -- Is i within the bounds of Current? -- (from TO_SPECIAL) feature -- Element change put (v: NATURAL_8; i: INTEGER_32) -- Replace i-th entry, if in index interval, by v. -- (from TO_SPECIAL) require -- from TO_SPECIAL valid_index: valid_index (i) ensure -- from TO_SPECIAL inserted: item (i) = v set_is_following_symlinks (v: BOOLEAN) -- Should `update` follow symlinks or not? -- (from FILE_INFO) ensure -- from FILE_INFO is_following_symlinks_set: is_following_symlinks = v update (f_name: READABLE_STRING_GENERAL) -- Update information buffer: fill it in with information -- from the inode of f_name. -- (from FILE_INFO) require -- from FILE_INFO f_name_not_empty: not f_name.is_empty feature -- Duplication copy (other: UNIX_FILE_INFO) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from FILE_INFO) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other ensure then -- from FILE_INFO not_shared_if_different: other /= Current implies buffered_file_info /= other.buffered_file_info equal_buffered_file_infos: buffered_file_info ~ other.buffered_file_info frozen deep_copy (other: UNIX_FILE_INFO) -- 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: UNIX_FILE_INFO -- 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: UNIX_FILE_INFO) -- 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: UNIX_FILE_INFO -- 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: UNIX_FILE_INFO -- 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 UNIX_FILE_INFO -- 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 -- 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 ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2012, 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_FILE_INFO -- Generated by Eiffel Studio --
For more details: eiffel.org