+
Point of view
All features
deferred class UNIXISH_PATH_NAME
Summary
A PATH_NAME that is more or less built after the same model as traditional unix path names.
Direct parents
Inherit list: PATH_NAME
Known children
Inherit list: MICROSOFT_PATH_NAME, POSIX_PATH_NAME
Class invariant
Overview
Features
Access
{ANY}
Operations
{ANY}
Constants
{ANY}
{PATH_JOINER}
{}
Creation/ Initialization
{ANY}
Access
{ANY}
Operations
{ANY}
  • to_absolute
    Transform into equivalent absolute path
  • normalize_case
    Transform into normalized case version (equivalent), with standard path separators
  • normalize
    Normalize removing double separators, and up-references
  • remove_last
    Remove last component of path (keep the "dirname")
  • add_last (elem: STRING)
  • join (other: PATH_NAME)
    Join with other using filesystem semantics
  • expand_user
    Replace an initial "~" or "~user" by user home directory
  • expand_variables
    Replace substrings of form $name or ${name} with environment variable values
  • expand_shellouts
    Replace substrings of form $(command) with execution of shell commands
{PATH_JOINER}
{}
  • tmp: UNIXISH_PATH_NAME
{PATH_JOINER}
  • start_join (drive: STRING, absoluteness: INTEGER_32)
    Start joining an absolute path to Current
    drive is optional absoluteness is, e.g., the number of leading slashes:
      0 for relative paths
      1 for absolute paths
      more for super-absolute paths (for instance, network-wide)
    
  • join_directory (element: STRING)
    Add a directory to the end of the path
  • join_file (element: STRING)
    Add a file to the end of the path
last: STRING
deferred function
{ANY}
Last component (also known as "basename")
require
  • not is_empty
ensure
extension: STRING
deferred function
{ANY}
Path extension (may be empty)
ensure
  • is_extension: not Result.is_empty implies Result.first = extension_separator
  • is_minimal: Result.occurrences(extension_separator) <= 1
  • not Result.has(directory_separator)
  • is_suffix: to_string.has_suffix(Result)
  • is_extension: not Result.is_empty implies Result.first = extension_separator
  • is_minimal: Result.occurrences(extension_separator) <= 1
  • not Result.has(directory_separator)
  • is_empty implies Result.is_empty
is_valid_file_name (elem: STRING): BOOLEAN
effective function
{ANY}
Does path only contain valid characters for a file?
The result does not imply that there is actually a file or directory with that name. Not the same as is_valid_path: path separators (/ for unix, \ for windows, ...) are allowed in paths, but not in file names. This operation does not perform any disk access.
require
  • elem /= Void
ensure
is_valid_directory: BOOLEAN
is True
constant attribute
{ANY}
Does Current represent a syntactically valid directory path?
For many Systems, there may be no syntactical difference between file paths and directory paths, in that case is_valid_directory is always True.
ensure
  • Result or is_valid_file
is_valid_file: BOOLEAN
effective function
{ANY}
Does Current represent a syntactically valid directory path?
For many Systems, there may be no syntactical difference between file paths and directory paths, in that case is_valid_file is always True.
ensure
  • Result or is_valid_directory
is_separator (ch: CHARACTER): BOOLEAN
effective function
{ANY}
Is ch a possible path separator?
ensure
go_up
effective procedure
{ANY}
Go up by one directory
join_to (other: PATH_JOINER)
effective procedure
{ANY}
require
  • other /= Void
short_name: STRING
effective function
{ANY}
ensure
  • Result /= Void
extension_separator: CHARACTER
deferred function
{ANY}
Character used to separate filenames from extensions
directory_separator: CHARACTER
deferred function
{ANY}
Character used to separate directories This character is forbidden in filenames
up_directory: STRING
deferred function
{ANY}
this_directory: STRING
deferred function
{ANY}
join_element (element: STRING)
effective procedure
Add an unspecified element (directory or file) to the end of the path
require
  • element /= Void
ensure
  • old join_error implies join_error
join_extension (an_extension: STRING)
effective procedure
Add an extension to the last element of the path
require
  • an_extension /= Void
ensure
  • old join_error implies join_error
join_error: BOOLEAN
is False
constant attribute
Did an error occur during joining
path: STRING
writable attribute
{}
start_join_to (other: PATH_JOINER): INTEGER_32
deferred function
{}
require
  • other /= Void
ensure
  • Result.in_range(path.lower, path.upper + 1)
scan_element (p: INTEGER_32, element: STRING): INTEGER_32
effective function
{}
require
  • path.valid_index(p)
  • element /= Void
ensure
  • Result.in_range(p + 1, path.upper + 1)
  • path.substring(p, Result - 1).has_suffix(element)
join_directory_to (other: PATH_JOINER, element: STRING)
effective procedure
{}
require
  • other /= Void
  • not element.is_empty
join_element_to (other: PATH_JOINER, element: STRING)
effective procedure
{}
require
  • other /= Void
  • not element.is_empty
make_empty
deferred procedure
{ANY}
Make a 'null' path
ensure
make_root
deferred procedure
{ANY}
Path to root directory (in current drive)
ensure
make_current
deferred procedure
{ANY}
Path to current directory (relative).
See also to_absolute if you need the absolute current working directory
ensure
make_from_string (s: STRING)
deferred procedure
{ANY}
require ensure
make_from_path_name (pn: PATH_NAME)
effective procedure
{ANY}
require
  • pn /= Void
to_string: STRING
deferred function
{ANY}
String representation
ensure
drive_specification: STRING
deferred function
{ANY}
Drive specified by the current path, Void if none
ensure
  • Result /= Void implies to_string.has_prefix(Result)
count: INTEGER_32
deferred function
{ANY}
Number of elements in_path
ensure
  • Result >= 0
is_empty: BOOLEAN
effective function
{ANY}
Path is null.
Note that you can have a null absolute path (i.e., root) or a null relative path (current directory)
ensure
is_absolute: BOOLEAN
deferred function
{ANY}
absolute path?
as_absolute: UNIXISH_PATH_NAME
effective function
{ANY}
Equivalent absolute path
ensure
is_normalized: BOOLEAN
deferred function
{ANY}
Has no redundant separators, or redundant up-references
is_valid_path (path: STRING): BOOLEAN
deferred function
{ANY}
Does path represent a syntactically valid file or directory path?
The result does not imply that there actually a file or directory with that name. This operation does not perform any disk access.
require
  • path /= Void
ensure
  • path.is_equal(old path.twin)
is_file: BOOLEAN
effective function
{ANY}
Path points to an existing regular file?
is_directory: BOOLEAN
effective function
{ANY}
Path points to an existing directory?
infix "+" (other: UNIXISH_PATH_NAME): UNIXISH_PATH_NAME
effective function
{ANY}
Join with other using filesystem semantics
require
  • other /= Void
infix "/" (elem: STRING): UNIXISH_PATH_NAME
effective function
{ANY}
Path with elem inside current
require ensure
to_absolute
deferred procedure
{ANY}
Transform into equivalent absolute path
normalize_case
deferred procedure
{ANY}
Transform into normalized case version (equivalent), with standard path separators
normalize
deferred procedure
{ANY}
Normalize removing double separators, and up-references
ensure
remove_last
deferred procedure
{ANY}
Remove last component of path (keep the "dirname")
require ensure
add_last (elem: STRING)
deferred procedure
{ANY}
require ensure
join (other: PATH_NAME)
effective procedure
{ANY}
Join with other using filesystem semantics
require
  • other /= Void
ensure
  • old is_normalized implies is_normalized
    definition: to_string.is_equal (old (Current+other).to_string) assertion above is commented out because of SE bug

expand_user
deferred procedure
{ANY}
Replace an initial "~" or "~user" by user home directory
ensure
expand_variables
effective procedure
{ANY}
Replace substrings of form $name or ${name} with environment variable values
ensure
expand_shellouts
deferred procedure
{ANY}
Replace substrings of form $(command) with execution of shell commands
ensure
join_up
effective procedure
Go up one directory
ensure
  • old join_error implies join_error
end_join
effective procedure
Finish joining the path
ensure
  • old join_error implies join_error
tmp: UNIXISH_PATH_NAME
deferred function
{}
ensure
  • Result /= Void
start_join (drive: STRING, absoluteness: INTEGER_32)
deferred procedure
Start joining an absolute path to Current
drive is optional absoluteness is, e.g., the number of leading slashes:
  0 for relative paths
  1 for absolute paths
  more for super-absolute paths (for instance, network-wide)
require
  • absoluteness >= 0
join_directory (element: STRING)
effective procedure
Add a directory to the end of the path
require
  • element /= Void
ensure
join_file (element: STRING)
effective procedure
Add a file to the end of the path
require
  • element /= Void
ensure