+
Point of view
All features
deferred class PATH_NAME
Summary
top
Operating system path name
Direct parents
Inherit list: PATH_JOINER
Known children
Inherit list: UNIXISH_PATH_NAME
Overview
top
Features
Creation/ Initialization
{ANY}
Constants
{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")
  • go_up
    Go up by one directory
  • add_last (elem: STRING)
  • join (other: PATH_NAME)
    Join with other using filesystem semantics
  • join_to (other: PATH_JOINER)
  • 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: 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
  • join_element (element: STRING)
    Add an unspecified element (directory or file) to the end of the path
  • join_extension (an_extension: STRING)
    Add an extension to the last element of the path
  • join_error: BOOLEAN
    Did an error occur during joining
make_empty
deferred procedure
{ANY}
top
Make a 'null' path
ensure
make_root
deferred procedure
{ANY}
top
Path to root directory (in current drive)
ensure
make_current
deferred procedure
{ANY}
top
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}
top
require ensure
make_from_path_name (pn: PATH_NAME)
effective procedure
{ANY}
top
require
  • pn /= Void
extension_separator: CHARACTER
deferred function
{ANY}
top
Character used to separate filenames from extensions
directory_separator: CHARACTER
deferred function
{ANY}
top
Character used to separate directories This character is forbidden in filenames
to_string: STRING
deferred function
{ANY}
top
String representation
ensure
drive_specification: STRING
deferred function
{ANY}
top
Drive specified by the current path, Void if none
ensure
  • Result /= Void implies to_string.has_prefix(Result)
count: INTEGER_32
deferred function
{ANY}
top
Number of elements in_path
ensure
  • Result >= 0
is_empty: BOOLEAN
effective function
{ANY}
top
Path is null.
Note that you can have a null absolute path (i.e., root) or a null relative path (current directory)
ensure
last: STRING
deferred function
{ANY}
top
Last component (also known as "basename")
require ensure
extension: STRING
deferred function
{ANY}
top
Path extension (may be empty)
ensure
is_absolute: BOOLEAN
deferred function
{ANY}
top
absolute path?
as_absolute: PATH_NAME
effective function
{ANY}
top
Equivalent absolute path
ensure
is_normalized: BOOLEAN
deferred function
{ANY}
top
Has no redundant separators, or redundant up-references
is_valid_path (path: STRING): BOOLEAN
deferred function
{ANY}
top
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_valid_file_name (name: STRING): BOOLEAN
deferred function
{ANY}
top
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
  • name /= Void
ensure
  • name.is_equal(old name.twin)
is_valid_directory: BOOLEAN
deferred function
{ANY}
top
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
is_valid_file: BOOLEAN
deferred function
{ANY}
top
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
is_file: BOOLEAN
effective function
{ANY}
top
Path points to an existing regular file?
is_directory: BOOLEAN
effective function
{ANY}
top
Path points to an existing directory?
infix "+" (other: PATH_NAME): PATH_NAME
effective function
{ANY}
top
Join with other using filesystem semantics
require
  • other /= Void
infix "/" (elem: STRING): PATH_NAME
effective function
{ANY}
top
Path with elem inside current
require ensure
short_name: STRING
deferred function
{ANY}
top
ensure
  • Result /= Void
to_absolute
deferred procedure
{ANY}
top
Transform into equivalent absolute path
normalize_case
deferred procedure
{ANY}
top
Transform into normalized case version (equivalent), with standard path separators
normalize
deferred procedure
{ANY}
top
Normalize removing double separators, and up-references
ensure
remove_last
deferred procedure
{ANY}
top
Remove last component of path (keep the "dirname")
require ensure
go_up
deferred procedure
{ANY}
top
Go up by one directory
add_last (elem: STRING)
deferred procedure
{ANY}
top
require ensure
join (other: PATH_NAME)
effective procedure
{ANY}
top
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

join_to (other: PATH_JOINER)
deferred procedure
{ANY}
top
require
  • other /= Void
expand_user
deferred procedure
{ANY}
top
Replace an initial "~" or "~user" by user home directory
ensure
expand_variables
effective procedure
{ANY}
top
Replace substrings of form $name or ${name} with environment variable values
ensure
expand_shellouts
deferred procedure
{ANY}
top
Replace substrings of form $(command) with execution of shell commands
ensure
join_up
effective procedure
{PATH_JOINER}
top
Go up one directory
ensure
  • old join_error implies join_error
end_join
effective procedure
{PATH_JOINER}
top
Finish joining the path
ensure
  • old join_error implies join_error
tmp: PATH_NAME
deferred function
{}
top
ensure
  • Result /= Void
start_join (drive: STRING, absoluteness: INTEGER_32)
deferred procedure
{PATH_JOINER}
top
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
{PATH_JOINER}
top
Add a directory to the end of the path
require
  • element /= Void
ensure
join_file (element: STRING)
effective procedure
{PATH_JOINER}
top
Add a file to the end of the path
require
  • element /= Void
ensure
join_element (element: STRING)
deferred procedure
{PATH_JOINER}
top
Add an unspecified element (directory or file) to the end of the path
require
  • element /= Void
ensure
join_extension (an_extension: STRING)
deferred procedure
{PATH_JOINER}
top
Add an extension to the last element of the path
require
  • an_extension /= Void
ensure
join_error: BOOLEAN
deferred function
{PATH_JOINER}
top
Did an error occur during joining