+
Point of view
All features
class SETTINGS
Summary
top
The setting of wrappers-generator.
Direct parents
Inherit list: SINGLETON
Insert list: BASIC_DIRECTORY, FILE_TOOLS
Class invariant
top
Overview
top
Features
Queries
{ANY}
Setters
{ANY}
{ANY}
  • is_equal (other: SETTINGS): BOOLEAN
    Is other attached to an object considered equal to current object?
{}
{ANY}
{}
{}
State of Current basic directory stream:
{ANY}
Connect and disconnect:
{ANY}
  • connect_to (directory_path: ABSTRACT_STRING)
    Try to connect Current to some existing directory_path.
  • connect_with (some_path: ABSTRACT_STRING)
    Try to connect Current to some directory using some_path which may be either an existing directory path or some arbitrary file path name.
  • connect_to_current_working_directory
    Try to connect Current to the current working directory.
  • disconnect
    Do not forget to call this feature when you have finished with some previously opened directory stream.
Scanning:
{ANY}
File path handling tools:
{ANY}
Disk modification:
{ANY}
Miscellaneous:
{ANY}
{DIRECTORY_NOTATION_HANDLER}
{}
global: BOOLEAN
writable attribute
{ANY}
top
verbose: BOOLEAN
writable attribute
{ANY}
top
directory: STRING
is "."
constant attribute
{ANY}
top
Default output is on current directory.
typedefs: STRING
writable attribute
{ANY}
top
standard_typedefs_class: STRING
writable attribute
{ANY}
top
are_standard_typedefs_emitted: BOOLEAN
writable attribute
{ANY}
top
last_error: STRING
writable attribute
{ANY}
top
set_verbose (a_value: BOOLEAN)
effective procedure
{ANY}
top
set_global (a_value: BOOLEAN)
effective procedure
{ANY}
top
set_typedefs (a_typedefs: STRING)
effective procedure
{ANY}
top
set_standard_typedefs (a_class_name: STRING)
effective procedure
{ANY}
top
use_standard_typedefs
effective procedure
{ANY}
top
unset_use_standard_typedefs
effective procedure
{ANY}
top
set_error (an_error: STRING)
effective procedure
{ANY}
top
is_equal (other: SETTINGS): BOOLEAN
effective function
{ANY}
top
Is other attached to an object considered equal to current object?
is_real_singleton: BOOLEAN
effective function
{}
top
singleton_memory_pool: HASHED_DICTIONARY[POINTER, STRING]
once function
{}
top
This pool is unique in the whole system.
current_is_not_an_expanded_type: BOOLEAN
effective function
{}
top
Check that the dynamic type of the SINGLETON is not an expanded type.
same_files (path1: ABSTRACT_STRING, path2: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if the path1 file exists and has the very same content as file path2.
same_physical_file (path1: ABSTRACT_STRING, path2: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if path1 and path2 physically refer to the same file (e.g. symlinks to a same file will return True here)
file_exists (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
is_readable (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if path file exists and is either a readable file or an accessible directory.
is_empty (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
True if path file exists, is readable and is an empty file.
rename_to (old_path: ABSTRACT_STRING, new_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to change the name or the location of a file.
last_rename_succeeded: BOOLEAN
writable attribute
{ANY}
top
True if the last call to rename_to` was successful.
copy_to (source_path: ABSTRACT_STRING, target_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to copy the source into the target.
last_copy_succeeded: BOOLEAN
writable attribute
{ANY}
top
True if the last call to copy_to` was successful.
delete (path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to delete the given path file.
last_delete_succeeded: BOOLEAN
writable attribute
{ANY}
top
True if the last call to delete` was successful.
size_of (path: ABSTRACT_STRING): INTEGER_32
effective function
{ANY}
top
Total size of file path in number of bytes.
last_change_of (path: ABSTRACT_STRING): TIME
effective function
{ANY}
top
Of the last modification of path.
is_file (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is path a regular file?
is_directory (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is path a directory?
io_remove (path: POINTER): BOOLEAN
{}
top
To implement delete.
io_rename (old_path: POINTER, new_path: POINTER): BOOLEAN
{}
top
io_copy (source: POINTER, target: POINTER): BOOLEAN
{}
top
io_file_exists (path: POINTER): BOOLEAN
{}
top
io_same_physical_file (path1: POINTER, path2: POINTER): BOOLEAN
{}
top
fstat_st_size (path: POINTER): INTEGER_32
{}
top
fstat_st_mtime (path: POINTER): INTEGER_64
{}
top
fstat_st_is_file (path: POINTER): BOOLEAN
{}
top
fstat_st_is_dir (path: POINTER): BOOLEAN
{}
top
once function
{}
top
once function
{}
top
tmp_string: STRING
once function
{}
top
directory_stream: POINTER
writable attribute
{}
top
This pointer memorize the current directory stream being scanned (used to compute is_connected).
current_entry: POINTER
writable attribute
{}
top
When is_connected, memorize the current entry in the current directory_stream.
is_connected: BOOLEAN
effective function
{ANY}
top
Is Current connected to some directory stream ?
end_of_input: BOOLEAN
effective function
{ANY}
top
Is end of input reached ?
connect_to (directory_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to connect Current to some existing directory_path.
connect_with (some_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to connect Current to some directory using some_path which may be either an existing directory path or some arbitrary file path name.
connect_to_current_working_directory
effective procedure
{ANY}
top
Try to connect Current to the current working directory.
disconnect
effective procedure
{ANY}
top
Do not forget to call this feature when you have finished with some previously opened directory stream.
last_entry: STRING
once function
{ANY}
top
Unique global buffer (once object) to get the last information computed by many routines of this class: read_entry, connect_with connect_to_current_working_directory, compute_parent_directory_of, ...
read_entry
effective procedure
{ANY}
top
Read the next entry name and update last_entry and end_of_input accordingly.
compute_parent_directory_of (some_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Using some_path (which may be either a file path or a directory path) tries to compute in the last_entry buffer the parent directory of some_path.
compute_subdirectory_with (parent_path: ABSTRACT_STRING, entry_name: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to compute in the last_entry buffer the new subdirectory path obtained when trying to concatenate smartly parent_path with some entry_name.
compute_file_path_with (parent_path: ABSTRACT_STRING, file_name: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to compute in the last_entry buffer the new file path obtained when trying to concatenate smartly parent_path with some file_name.
compute_absolute_file_path_with (path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to compute an absolute path equivalent to path and store it in last_entry.
compute_short_name_of (path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to find the short name of the file or directory given by its path and store it in last_entry.
valid_path (path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Is the syntax of path valid for the system notation?
change_current_working_directory (directory_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to change the current working directory using some directory_path.
current_working_directory: FIXED_STRING
effective function
{ANY}
top
The current working directory.
ensure_system_notation
once procedure
{ANY}
top
require_system_notation: BOOLEAN
once function
{ANY}
top
Same as ensure_system_notation, useful for contracts
create_new_directory (directory_path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Try to create a new directory using the directory_path name.
remove_directory (directory_path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Try to remove directory directory_path which must be empty.
remove_files_of (directory_path: ABSTRACT_STRING)
effective procedure
{ANY}
top
Try to remove all files (not subdirectories) of directory specified by directory_path.
remove_recursively (directory_path: ABSTRACT_STRING): BOOLEAN
effective function
{ANY}
top
Try to remove all files and all subdirectories of directory specified by directory_path.
is_case_sensitive: BOOLEAN
effective function
{ANY}
top
system_notation: DIRECTORY_NOTATION
effective function
{ANY}
top
system_notation_buffer: REFERENCE[DIRECTORY_NOTATION]
once function
{DIRECTORY_NOTATION_HANDLER}
top
Unique common buffer to memorize the system path notation.
system_notation_detected: BOOLEAN
effective function
{DIRECTORY_NOTATION_HANDLER}
top
unix_notation: BOOLEAN
effective function
{DIRECTORY_NOTATION_HANDLER}
top
The Unix like file path notation looks like: 
  /LibertyEiffel/sys/system.se
windows_notation: BOOLEAN
effective function
{DIRECTORY_NOTATION_HANDLER}
top
The Windows like file path notation looks like: 
  C:\LibertyEiffel\sys\system.se
cygwin_notation: BOOLEAN
effective function
{DIRECTORY_NOTATION_HANDLER}
top
The Cygwin like file path notation looks like: 
  //C/LibertyEiffel/sys/system.se
set_notation_using (some_path: ABSTRACT_STRING)
effective procedure
{DIRECTORY_NOTATION_HANDLER}
top
Try to detect automatically the file system notation.
reset_notation_using (some_path: ABSTRACT_STRING)
effective procedure
{DIRECTORY_NOTATION_HANDLER}
top
Try to detect automatically the file system notation.
reset_notation
effective procedure
{DIRECTORY_NOTATION_HANDLER}
top
tmp_path: STRING
once function
{}
top
directory_open (path_pointer: POINTER): POINTER
{}
top
Try to open some existing directory using path.
directory_read_entry (dirstream: POINTER): POINTER
{}
top
Read an return a new entry using the directory handle dirstream obtained with function basic_directory_open.
directory_get_entry_name (entry: POINTER): POINTER
{}
top
Read an return a new entry using the directory handle dirstream obtained with function basic_directory_open.
directory_close (dirstream: POINTER): BOOLEAN
{}
top
Try to close some opened dirstream directory.
directory_current_working_directory: POINTER
{}
top
Try to get the current working directory path.
directory_chdir (destination: POINTER): BOOLEAN
{}
top
Try to change the current working directory using destination.
directory_mkdir (directory_path: POINTER): BOOLEAN
{}
top
Try to create a new directory using directory_path.
directory_rmdir (directory_path: POINTER): BOOLEAN
{}
top
Try to remove directory_path.