+
Point of view
All features
class POSIX_PATH_NAME
Summary
top
Operating system path name, POSIX notation
Direct parents
Inherit list: UNIXISH_PATH_NAME
Class invariant
top
Overview
top
Creation features
{ANY}
Features
Creation
{ANY}
Constants
{ANY}
Access
{ANY}
Operations
{ANY}
  • to_absolute
    Transform into equivalent absolute path
  • normalize
    Normalize removing double separators, and up-references
  • normalize_case
    Transform into normalized case version (equivalent), with standard path separators
  • remove_last
    Remove last component of path (keep the "dirname")
  • add_last (elem: STRING)
  • expand_user
    Replace an initial "~" or "~user" by user home directory
  • expand_shellouts
    Replace substrings of form $(command) with execution of shell commands
Copying, comparison
{ANY}
  • copy (other: POSIX_PATH_NAME)
    Update current object using fields of object attached to other, so as to yield equal objects.
  • is_equal (other: POSIX_PATH_NAME): BOOLEAN
    Is other attached to an object considered equal to current object?
{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)
Auxiliary constants/onces
{}
Access
{ANY}
Operations
{ANY}
{PATH_JOINER}
{}
Creation/ Initialization
{ANY}
Access
{ANY}
Operations
{ANY}
  • join (other: PATH_NAME)
    Join with other using filesystem semantics
  • expand_variables
    Replace substrings of form $name or ${name} with environment variable values
{PATH_JOINER}
{PATH_JOINER}
make_empty
effective procedure
{ANY}
top
Make a 'null' path
make_root
effective procedure
{ANY}
top
Path to root directory (in current drive)
make_current
effective procedure
{ANY}
top
Path to current directory (relative).
make_from_string (s: STRING)
effective procedure
{ANY}
top
extension_separator: CHARACTER
is '.'
constant attribute
{ANY}
top
Character used to separate filenames from extensions
directory_separator: CHARACTER
is '/'
constant attribute
{ANY}
top
Character used to separate directories This character is forbidden in filenames
up_directory: STRING
is ".."
constant attribute
{ANY}
top
this_directory: STRING
is "."
constant attribute
{ANY}
top
drive_specification: STRING
effective function
{ANY}
top
Drive specified by the current path, Void if none
count: INTEGER_32
effective function
{ANY}
top
Number of elements in_path
last: STRING
effective function
{ANY}
top
Last component (also known as "basename")
extension: STRING
effective function
{ANY}
top
Path extension (may be empty)
is_absolute: BOOLEAN
effective function
{ANY}
top
absolute path?
is_normalized: BOOLEAN
effective function
{ANY}
top
Has no redundant separators, or redundant up-references
is_valid_path (path: STRING): BOOLEAN
effective function
{ANY}
top
Does path represent a syntactically valid file or directory path?
to_absolute
effective procedure
{ANY}
top
Transform into equivalent absolute path
normalize
effective procedure
{ANY}
top
Normalize removing double separators, and up-references
normalize_case
effective procedure
{ANY}
top
Transform into normalized case version (equivalent), with standard path separators
remove_last
effective procedure
{ANY}
top
Remove last component of path (keep the "dirname")
add_last (elem: STRING)
effective procedure
{ANY}
top
expand_user
effective procedure
{ANY}
top
Replace an initial "~" or "~user" by user home directory
expand_shellouts
effective procedure
{ANY}
top
Replace substrings of form $(command) with execution of shell commands
copy (other: POSIX_PATH_NAME)
effective procedure
{ANY}
top
Update current object using fields of object attached to other, so as to yield equal objects.
is_equal (other: POSIX_PATH_NAME): BOOLEAN
effective function
{ANY}
top
Is other attached to an object considered equal to current object?
start_join (drive: STRING, absoluteness: INTEGER_32)
effective 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)
tmp: POSIX_PATH_NAME
once function
{}
top
double_slash: STRING
is "//"
constant attribute
{}
top
start_join_to (other: PATH_JOINER): INTEGER_32
effective function
{}
top
is_valid_file_name (elem: STRING): BOOLEAN
effective function
{ANY}
top
Does to_string only contain valid characters for a file?
is_valid_directory: BOOLEAN
is True
constant attribute
{ANY}
top
Does Current represent a syntactically valid directory path?
is_valid_file: BOOLEAN
effective function
{ANY}
top
Does Current represent a syntactically valid directory path?
is_separator (ch: CHARACTER): BOOLEAN
effective function
{ANY}
top
Is ch a possible path separator?
go_up
effective procedure
{ANY}
top
Go up by one directory
join_to (other: PATH_JOINER)
effective procedure
{ANY}
top
short_name: STRING
effective function
{ANY}
top
join_element (element: STRING)
effective procedure
{PATH_JOINER}
top
Add an unspecified element (directory or file) to the end of the path
join_extension (an_extension: STRING)
effective procedure
{PATH_JOINER}
top
Add an extension to the last element of the path
join_error: BOOLEAN
is False
constant attribute
{PATH_JOINER}
top
Did an error occur during joining
path: STRING
writable attribute
{}
top
scan_element (p: INTEGER_32, element: STRING): INTEGER_32
effective function
{}
top
join_directory_to (other: PATH_JOINER, element: STRING)
effective procedure
{}
top
join_element_to (other: PATH_JOINER, element: STRING)
effective procedure
{}
top
make_from_path_name (pn: PATH_NAME)
effective procedure
{ANY}
top
to_string: STRING
deferred function
{ANY}
top
String representation
is_empty: BOOLEAN
effective function
{ANY}
top
Path is null.
as_absolute: POSIX_PATH_NAME
effective function
{ANY}
top
Equivalent absolute path
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: POSIX_PATH_NAME): POSIX_PATH_NAME
effective function
{ANY}
top
Join with other using filesystem semantics
infix "/" (elem: STRING): POSIX_PATH_NAME
effective function
{ANY}
top
Path with elem inside current
join (other: PATH_NAME)
effective procedure
{ANY}
top
Join with other using filesystem semantics
expand_variables
effective procedure
{ANY}
top
Replace substrings of form $name or ${name} with environment variable values
join_up
effective procedure
{PATH_JOINER}
top
Go up one directory
end_join
effective procedure
{PATH_JOINER}
top
Finish joining the path
join_directory (element: STRING)
effective procedure
{PATH_JOINER}
top
Add a directory to the end of the path
join_file (element: STRING)
effective procedure
{PATH_JOINER}
top
Add a file to the end of the path