deferred class PATH_NAME_NOTATION
Summary
Direct parents
Inherit list: DIRECTORY_NOTATION, PATH_JOINER
Known children
Inherit list: UNIX_DIRECTORY_NOTATION, WINDOWS_DIRECTORY_NOTATION
Overview
Features
DIRECTORY_NOTATION interface
{ANY}
{DIRECTORY_NOTATION}
{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_up
    Go up one directory
  • 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
  • end_join
    Finish joining the path
  • join_error: BOOLEAN
    Did an error occur during joining
{PATH_NAME_NOTATION}
{}
{ANY}
{ANY}
{ANY}
to_parent_directory (some_path: STRING)
effective procedure
{ANY}
Tries to compute in some_path (which may be either a file path or a directory path) the parent directory of some_path.
to_subdirectory_with (parent_path: STRING, entry_name: STRING)
effective procedure
{ANY}
Try to compute in parent_path the new subdirectory path obtained when trying to concatenate smartly parent_path with some entry_name.
to_file_path_with (parent_path: STRING, file_name: STRING)
effective procedure
{ANY}
Try to compute in parent_path the new file path obtained when trying to concatenate smartly parent_path with some file_name.
to_subpath_with (parent_path: STRING, subpath: STRING)
effective procedure
{ANY}
Try to compute in parent_path the new file path obtained when trying to concatenate smartly parent_path with some subpath.
can_map_drive (source_notation: DIRECTORY_NOTATION, drive: STRING): BOOLEAN
effective function
{ANY}
to_root (source_notation: DIRECTORY_NOTATION, drive: STRING)
effective procedure
{ANY}
Convert drive from a drive letter/device name in source_notation to an absolute path in Current notation.
to_default_root (directory: STRING)
effective procedure
{ANY}
to_current_directory (directory: STRING)
effective procedure
{ANY}
Put the relative directory representing the current working directory into directory.
is_absolute_path (path: STRING): BOOLEAN
effective function
{ANY}
Is path absolute, i.e.
is_valid_path (a_path: STRING): BOOLEAN
effective function
{ANY}
Does path represent a syntactically valid file or directory path?
is_valid_directory_path (a_path: STRING): BOOLEAN
effective function
{ANY}
Does path represent a syntactically valid directory path?
is_valid_file_name (name: STRING): BOOLEAN
effective function
{ANY}
Does path only contain valid characters for a file?
to_short_name_in (buffer: STRING, path: STRING)
effective procedure
{ANY}
to_notation (path: STRING, destination: DIRECTORY_NOTATION): STRING
effective function
start_join (drive: STRING, absoluteness: INTEGER_32)
effective 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)
join_directory (element: STRING)
effective procedure
Add a directory to the end of the path
join_up
effective procedure
Go up one directory
join_file (element: STRING)
effective procedure
Add a file to the end of the path
join_element (element: STRING)
effective procedure
Add an unspecified element (directory or file) to the end of the path
join_extension (an_extension: STRING)
effective procedure
Add an extension to the last element of the path
end_join
effective procedure
Finish joining the path
join_error: BOOLEAN
is False
constant attribute
Did an error occur during joining
from_path_name (other: PATH_NAME): STRING
effective function
tmp1: PATH_NAME
deferred function
{}
tmp2: PATH_NAME
deferred function
{}
current_path: STRING
writable attribute
{}
destination_notation: DIRECTORY_NOTATION
writable attribute
{}
is_current_directory (path: STRING): BOOLEAN
deferred function
{ANY}
is_parent_directory (path: STRING): BOOLEAN
deferred function
{ANY}
to_absolute_path_in (possible_parent: STRING, path: STRING)
frozen
effective procedure
{ANY}
If path is not absolute, make it so by appending it to possible_parent.
from_notation (source_notation: DIRECTORY_NOTATION, path: STRING)
frozen
effective procedure
{ANY}
Convert path from source_notation to Current notation.
can_sanitize (name: STRING): BOOLEAN
effective function
{ANY}
to_valid_file_name (name: STRING)
effective procedure
{ANY}
Sanitize name (by removing forbidden characters or encoding them)
to_directory_path (path: STRING)
deferred procedure
{ANY}
Make sure that the given path is a canonical directory path as would be returned by to_subdirectory_with
is_case_sensitive: BOOLEAN
deferred function
{ANY}