-- (c) Copyright - See License.txt

--

--****

-- == File System

--

-- Cross platform file operations for Euphoria

--

-- <>

namespace filesys

include std/dll.e

include std/machine.e

include std/wildcard.e

include std/sort.e

include std/search.e

include std/machine.e

include std/sequence.e

include std/types.e

include std/text.e

include std/io.e

include std/datetime.e as dt

include std/get.e -- for disk_size()

end ifdef

constant

constant lib = open_dll("kernel32")

constant xCopyFile = define_c_func(lib, "CopyFileA", {C_POINTER, C_POINTER, C_BOOL},

C_BOOL)

constant xMoveFile = define_c_func(lib, "MoveFileA", {C_POINTER, C_POINTER}, C_BOOL)

constant xDeleteFile = define_c_func(lib, "DeleteFileA", {C_POINTER}, C_BOOL)

constant xCreateDirectory = define_c_func(lib, "CreateDirectoryA",

{C_POINTER, C_POINTER}, C_BOOL)

constant xRemoveDirectory = define_c_func(lib, "RemoveDirectoryA", {C_POINTER}, C_BOOL)

constant xGetFileAttributes= define_c_func(lib, "GetFileAttributesA", {C_POINTER}, C_INT) -- N.B DWORD return fails this.

constant xGetDiskFreeSpace = define_c_func(lib, "GetDiskFreeSpaceA",

{C_POINTER, C_POINTER, C_POINTER, C_POINTER, C_POINTER}, C_BOOL)

elsifdef LINUX then

elsifdef FREEBSD or SUNOS or OPENBSD then

constant lib = open_dll("libc.so")

elsifdef OSX then

constant lib = open_dll("libc.dylib")

elsedef

constant xCopyFile = -1

constant xMoveFile = -1

constant xDeleteFile = -1

constant xCreateDirectory = -1

constant xRemoveDirectory = -1

constant xGetFileAttributes = -1

end ifdef

elsifdef UNIX then

constant xStatFile = define_c_func(lib, "stat", {C_POINTER, C_POINTER}, C_INT)

end ifdef

--constant xDeleteFile = define_c_func(lib, "remove", {C_POINTER}, C_LONG)

end ifdef

--****

-- === Constants

--****

-- Signature:

-- public constant SLASH

--

-- Description:

-- Current platform's path separator character

--

-- Comments:

-- When on //Windows//, '~\\'. When on //Unix//, '/'.

--

--****

-- Signature:

-- public constant SLASHES

--

-- Description:

-- Current platform's possible path separators. This is slightly different

-- in that on //Windows// the path separators variable contains

-- ##~\~\## as well as ##~:## and ##/## as newer //Windows// versions support

-- ##/## as a path separator. On //Unix// systems, it only contains ##/##.

--****

-- Signature:

-- public constant SLASHES

--

-- Description:

-- Current platform's possible path separators. This is slightly different

-- in that on //Windows// the path separators variable contains

-- ##~\~\## as well as ##~:## and ##/## as newer //Windows// versions support

-- ##/## as a path separator. On //Unix// systems, it only contains ##/##.

--****

-- Signature:

-- public constant EOLSEP

--

-- Description:

-- Current platform's newline string: ##"\n"## on //Unix//, else ##"\r\n"##.

--****

-- Signature:

-- public constant EOL

--

-- Description:

-- All platform's newline character: ##'\n'##. When text lines are read the native

-- platform's EOLSEP string is replaced by a single character EOL.

--****

-- Signature:

-- public constant PATHSEP

--

-- Description:

-- Current platform's path separator character: ##:## on //Unix//, else ##;##.

--****

-- Signature:

-- public constant NULLDEVICE

--

-- Description:

-- Current platform's null device path: ##/dev/null## on //Unix//, else ##NUL:##.

--****

-- Signature:

-- public constant SHARED_LIB_EXT

--

-- Description:

-- Current platform's shared library extension. For instance it can be ##dll##,

-- ##so## or ##dylib## depending on the platform.

public constant SHARED_LIB_EXT = "dylib"

elsedef

end ifdef

elsifdef WINDOWS then

public constant SLASH='\\'

public constant SLASHES = "\\/:"

public constant EOLSEP = "\r\n"

public constant PATHSEP = ';'

public constant NULLDEVICE = "NUL:"

public constant SHARED_LIB_EXT = "dll"

end ifdef

--****

-- === Directory Handling

public enum

--**

-- Bad path error code. See [[:walk_dir]]

--**

-- Return directory information for the specified file or directory.

--

-- Parameters:

-- # ##name## : a sequence, the name to be looked up in the file system.

--

-- Returns:

-- An **object**, -1 if no match found, else a sequence of sequence entries

--

-- Errors:

-- The length of ##name## should not exceed 1,024 characters.

--

-- Comments:

-- ##name## can also contain * and ? wildcards to select multiple files.

--

-- The returned information is similar to what you would get from the DIR command. A sequence

-- is returned where each element is a sequence that describes one file or subdirectory.

--

-- If ##name## refers to a **directory** you may have entries for "." and "..", just as with the

-- DIR command. If it refers to an existing **file**, and has no wildcards, then the returned

-- sequence will have just one entry, i.e. its length will be 1. If ##name## contains wildcards

-- you may have multiple entries.

--

-- Each entry contains the name, attributes and file size as well as

-- the year, month, day, hour, minute and second of the last modification.

-- You can refer to the elements of an entry with the following constants:

--

--

-- public constant

-- -- File Attributes

-- D_NAME = 1,

-- D_ATTRIBUTES = 2,

-- D_SIZE = 3,

-- D_YEAR = 4,

-- D_MONTH = 5,

-- D_DAY = 6,

-- D_HOUR = 7,

-- D_MINUTE = 8,

-- D_SECOND = 9

--

--

-- The attributes element is a string sequence containing characters chosen from:

--

-- || Attribute || Description ||

-- | 'd' | directory

-- | 'r' | read only file

-- | 'h' | hidden file

-- | 's' | system file

-- | 'v' | volume-id entry

-- | 'a' | archive file

--

-- A normal file without special attributes would just have an empty string, "", in this field.

--

-- The top level directory, e.g. c:\ does not have "." or ".." entries.

--

-- This function is often used just to test if a file or directory exists.

--

-- Under //WIN32//, st can have a long file or directory name anywhere in

-- the path.

--

-- Under //Unix//, the only attribute currently available is 'd'.

--

-- //WIN32//: The file name returned in D_NAME will be a long file name.

--

-- Example 1:

--

-- d = dir(current_dir())

--

-- -- d might have:

-- -- {

-- -- {".", "d", 0 1994, 1, 18, 9, 30, 02},

-- -- {"..", "d", 0 1994, 1, 18, 9, 20, 14},

-- -- {"fred", "ra", 2350, 1994, 1, 22, 17, 22, 40},

-- -- {"sub", "d" , 0, 1993, 9, 20, 8, 50, 12}

-- -- }

--

-- d[3][D_NAME] would be "fred"

--

--

-- See Also:

-- [[:walk_dir]]

--

object dir_data, data, the_name, the_dir

integer idx

-- Did the user give a wildcard? If not, just return the standard dir.

-- Empty if so that we can short circuit if * is found, otherwise

-- we would have to run a search for * and ? even if * is found.

else

end if

-- Is there a path involved?

else

-- Find a SLASH character and break the name there resulting in

-- a directory and file name.

end if

-- Get directory contents

-- Did an error occur?

end if

-- Filter the directory contents returning only those items

-- matching name.

end if

-- no matches found, act like it doesn't exist

end if

end function

--**

-- Return the name of the current working directory.

--

-- Returns:

-- A **sequence**, the name of the current working directory

--

-- Comments:

-- There will be no slash or backslash on the end of the current directory, except under

-- //Windows//, at the top-level of a drive, e.g. C:\

--

-- Example 1:

--

-- sequence s

-- s = current_dir()

-- -- s would have "C:\EUPHORIA\DOC" if you were in that directory

--

--

-- See Also:

-- [[:dir]], [[:chdir]]

-- returns name of current working directory

end function

--**

-- Set a new value for the current directory

--

-- Parameters:

-- ##newdir## : a sequence, the name for the new working directory.

--

-- Returns:

-- An **integer**, 0 on failure, 1 on success.

--

-- Comments:

-- By setting the current directory, you can refer to files in that directory using just

-- the file name.

--

-- The [[:current_dir]]() function will return the name of the current directory.

--

-- On //WIN32// the current directory is a public property shared

-- by all the processes running under one shell. On //Unix// a subprocess

-- can change the current directory for itself, but this won't

-- affect the current directory of its parent process.

--

-- Example 1:

--

-- if chdir("c:\\euphoria") then

-- f = open("readme.doc", "r")

-- else

-- puts(STDERR, "Error: No euphoria directory?\n")

-- end if

--

--

-- See Also:

-- [[:current_dir]], [[:dir]]

end function

-- Generalized recursive directory walker

-- Default directory sorting function for walk_dir().

-- * sorts by name *

object d

else

-- sort by name

end if

end function

-- override the dir sorting function with your own routine id

-- it's better not to use routine_id() here,

-- or else users will have to bind with clear routine names

--**

-- **Deprecated**, so therefore not documented.

--**

-- Generalized Directory Walker

--

-- Parameters:

-- # ##path_name## : a sequence, the name of the directory to walk through

-- # ##your_function## : the routine id of a function that will receive each path

-- returned from the result of ##dir_source##, one at a time.

-- # ##scan_subdirs## : an optional integer, 1 to also walk though subfolders, 0 (the default) to skip them all.

-- # ##dir_source## : an optional integer. A routine_id of a user-defined routine that

-- returns the list of paths to pass to ##your_function##. If omitted,

-- the [[:dir]]() function is used.

--

-- Returns:

-- An **object**,

-- * 0 on success

-- * W_BAD_PATH: an error occurred

-- * anything else: the custom function returned something to stop [[:walk_dir]]().

--

-- Comments:

-- This routine will "walk" through a directory named ##path_name##. For each entry in the

-- directory, it will call a function, whose routine_id is ##your_function##.

-- If ##scan_subdirs## is non-zero (TRUE), then the subdirectories in

-- ##path_name## will be walked through recursively in the very same way.

--

-- The routine that you supply should accept two sequences, the path name and dir() entry for

-- each file and subdirectory. It should return 0 to keep going, or non-zero to stop

-- ##walk_dir##(). Returning ##W_BAD_PATH## is taken as denoting some error.

--

-- This mechanism allows you to write a simple function that handles one file at a time,

-- while ##walk_dir##() handles the process of walking through all the files and subdirectories.

--

-- By default, the files and subdirectories will be visited in alphabetical order. To use

-- a different order, use the ##dir_source## to pass the routine_id of your own modified

-- [[:dir]] function that sorts the directory entries differently.

--

-- The path that you supply to ##walk_dir()## must not contain wildcards (* or ?). Only a

-- single directory (and its subdirectories) can be searched at one time.

--

-- For non-unix systems, any '/' characters in ##path_name## are replaced with '\'.

--

-- All trailing slash and whitespace characters are removed from ##path_name##.

--

-- Example 1:

--

-- function look_at(sequence path_name, sequence item)

-- -- this function accepts two sequences as arguments

-- -- it displays all C/C++ source files and their sizes

-- if find('d', item[D_ATTRIBUTES]) then

-- return 0 -- Ignore directories

-- end if

-- if not find(fileext(item[D_NAME]), {"c,h,cpp,hpp,cp"}) then

-- return 0 -- ignore non-C/C++ files

-- end if

-- printf(STDOUT, "%s%s%s: %d\n",

-- {path_name, SLASH, item[D_NAME], item[D_SIZE]})

-- return 0 -- keep going

-- end function

--

-- function mysort(sequence path)

-- object d

--

-- d = dir(path)

-- if atom(d) then

-- return d

-- end if

-- -- Sort in descending file size.

-- return sort_columns(d, {-D_SIZE})

-- end function

--

-- exit_code = walk_dir("C:\\MYFILES\\", routine_id("look_at"), TRUE, routine_id("mysort"))

--

--

-- See Also:

-- [[:dir]], [[:sort]], [[:sort_columns]]

object d, abort_now

object orig_func

object source_orig_func

object source_user_data

end if

end if

-- get the full directory information

else

end if

else

end if

end if

-- trim any trailing blanks or '\' '/' characters from the path

path_name = replace_all(path_name, '/', '\\')

end ifdef

end if

end if

-- a directory

orig_func, scan_subdirs, source_orig_func)

not equal(abort_now, W_BAD_PATH) then

-- allow BAD PATH, user might delete a file or directory

end if

end if

end if

end function

--**

-- Create a new directory.

--

-- Parameters:

-- # ##name## : a sequence, the name of the new directory to create

-- # ##mode## : on //Unix// systems, permissions for the new directory. Default is

-- 448 (all rights for owner, none for others).

-- # ##mkparent## : If true (default) the parent directories are also created

-- if needed.

--

-- Returns:

-- An **integer**, 0 on failure, 1 on success.

--

-- Comments:

-- ##mode## is ignored on non-Unix platforms.

--

-- Example 1:

--

-- if not create_directory("the_new_folder") then

-- crash("Filesystem problem - could not create the new folder")

-- end if

--

-- -- This example will also create "myapp/" and "myapp/interface/" if they don't exist.

-- if not create_directory("myapp/interface/letters") then

-- crash("Filesystem problem - could not create the new folder")

-- end if

--

-- -- This example will NOT create "myapp/" and "myapp/interface/" if they don't exist.

-- if not create_directory("myapp/interface/letters",,0) then

-- crash("Filesystem problem - could not create the new folder")

-- end if

--

--

-- See Also:

-- [[:remove_directory]], [[:chdir]]

atom pname, ret

integer pos

end if

-- Remove any trailing slash.

end if

end if

end if

elsifdef WIN32 then

ret = c_func(xCreateDirectory, {pname, 0})

mode = mode -- get rid of not used warning

end ifdef

end function

--**

-- Create a new file.

--

-- Parameters:

-- # ##name## : a sequence, the name of the new file to create

--

-- Returns:

-- An **integer**, 0 on failure, 1 on success.

--

-- Comments:

-- * The created file will be empty, that is it has a length of zero.

-- * The created file will not be open when this returns.

--

-- Example 1:

--

-- if not create_file("the_new_file") then

-- crash("Filesystem problem - could not create the new file")

-- end if

--

--

-- See Also:

-- [[:create_directory]]

end function

--**

-- Delete a file.

--

-- Parameters:

-- # ##name## : a sequence, the name of the file to delete.

--

-- Returns:

-- An **integer**, 0 on failure, 1 on success.

end ifdef

end function

--**

-- Returns the current directory, with a trailing SLASH

--

-- Parameters:

-- # ##drive_id## : For non-Unix systems only. This is the Drive letter to

-- to get the current directory of. If omitted, the current drive is used.

--

-- Returns:

-- A **sequence**, the current directory.

--

-- Comment:

-- Windows maintain a current directory for each disk drive. You

-- would use this routine if you wanted the current directory for a drive that

-- may not be the current drive.

--

-- For Unix systems, this is simply ignored because there is only one current

-- directory at any time on Unix.

--

-- Note:

-- This always ensures that the returned value has a trailing SLASH

-- character.

--

-- Example 1:

--

-- res = curdir('D') -- Find the current directory on the D: drive.

-- -- res might be "D:\backup\music\"

-- res = curdir() -- Find the current directory on the current drive.

-- -- res might be "C:\myapp\work\"

--

sequence lCurDir

sequence lOrigDir = ""

sequence lDrive

object void

if t_alpha(drive_id) then

lOrigDir = current_dir()

lDrive = " "

lDrive[1] = drive_id

lDrive[2] = ':'

if chdir(lDrive) = 0 then

lOrigDir = ""

end if

end if

end ifdef

if length(lOrigDir) > 0 then

void = chdir(lOrigDir[1..2])

end if

end ifdef

-- Ensure that it ends in a path separator.

end if

end function

--**

-- Returns the original current directory

--

-- Parameters:

-- # None.

--

-- Returns:

-- A **sequence**, the current directory at the time the program started running.

--

-- Comment:

-- You would use this if the program might change the current directory during

-- its processing and you wanted to return to the original directory.

--

-- Note:

-- This always ensures that the returned value has a trailing SLASH

-- character.

--

-- Example 1:

--

-- res = init_curdir() -- Find the original current directory.

--

end function

--- TODO

--- copy_directory( srcpath, destpath, structonly = 0)

--**

-- Clear (delete) a directory of all files, but retaining sub-directories.

--

-- Parameters:

-- # ##name## : a sequence, the name of the directory whose files you want to remove.

-- # ##recurse## : an integer, whether or not to remove files in the

-- directory's sub-directories. If 0 then this function is identical

-- to remove_directory(). If 1, then we recursively delete the

-- directory and its contents. Defaults to 1.

--

-- Returns:

-- An **integer**, 0 on failure, otherwise the number of files plus 1.

--

-- Comment:

-- This never removes a directory. It only ever removes files. It is used to

-- clear a directory structure of all existing files, leaving the structure

-- intact.

--

-- Example 1:

--

-- integer cnt = clear_directory("the_old_folder")

-- if cnt = 0 then

-- crash("Filesystem problem - could not remove one or more of the files.")

-- end if

-- printf(1, "Number of files removed: %d\n", cnt - 1)

--

--

-- See Also:

-- [[:remove_directory]], [[:delete_file]]

object files

integer ret

end if

end if

-- (btw, not allowed to clear root directory)

end if

if length(path) = 2 then

if path[2] = ':' then

return 0 -- nothing specified to delete

end if

end if

end ifdef

end if

if length( files ) < 3 then

return 0 -- Supplied name was not a directory

end if

if not equal(files[1][D_NAME], ".") then

return 0 -- Supplied name was not a directory

end if

if not eu:find('d', files[1][D_ATTRIBUTES]) then

return 0 -- Supplied name was not a directory

end if

elsedef

end if

end ifdef

for i = 3 to length(files) do

if eu:find('d', files[i][D_ATTRIBUTES]) then

if recurse then

integer cnt = clear_directory(path & files[i][D_NAME], recurse)

if cnt = 0 then

return 0

end if

ret += cnt

else

continue

end if

else

if delete_file(path & files[i][D_NAME]) = 0 then

return 0

end if

ret += 1

end if

end for

elsedef

end if

end if

else

end if

else

end if

end if

end ifdef

end function

--**

-- Remove a directory.

--

-- Parameters:

-- # ##name## : a sequence, the name of the directory to remove.

-- # ##force## : an integer, if 1 this will also remove files and

-- sub-directories in the directory. The default is

-- 0, which means that it will only remove the

-- directory if it is already empty.

--

-- Returns:

-- An **integer**, 0 on failure, 1 on success.

--

-- Example 1:

--

-- if not remove_directory("the_old_folder") then

-- crash("Filesystem problem - could not remove the old folder")

-- end if

--

--

-- See Also:

-- [[:create_directory]], [[:chdir]], [[:clear_directory]]

atom pname, ret

object files

-- Remove any trailing slash

end if

end if

-- (not allowed to delete root directory btw)

end if

if length(dir_name) = 2 then

if dir_name[2] = ':' then

return 0 -- nothing specified to delete

end if

end if

end ifdef

end if

if length( files ) <= 2 then

return 0 -- Supplied dir_name was not a directory

end if

if not equal(files[1][D_NAME], ".") then

return 0 -- Supplied name was not a directory

end if

if not eu:find('d', files[1][D_ATTRIBUTES]) then

return 0 -- Supplied name was not a directory

end if

if length(files) > 2 then

if not force then

return 0 -- Directory is not already emptied.

end if

end if

elsedef

end if

end ifdef

for i = 3 to length(files) do

if eu:find('d', files[i][D_ATTRIBUTES]) then

ret = remove_directory(dir_name & files[i][D_NAME] & SLASH, force)

else

ret = delete_file(dir_name & files[i][D_NAME])

end if

if not ret then

return 0

end if

end for

elsedef

end if

else

end if

end if

end ifdef

end ifdef

end function

--****

-- === File name parsing

public enum

--**

-- Parse a fully qualified pathname.

-- Parameters:

-- # ##path## : a sequence, the path to parse

--

-- Returns:

-- A **sequence**, of length 5. Each of these elements is a string:

-- * The path name

-- * The full unqualified file name

-- * the file name, without extension

-- * the file extension

-- * the drive id

--

-- Comments:

--

-- The host operating system path separator is used in the parsing.

--

-- Example 1:

--

-- -- WIN32

-- info = pathinfo("C:\\euphoria\\docs\\readme.txt")

-- -- info is {"C:\\euphoria\\docs", "readme.txt", "readme", "txt", "C"}

--

--

-- Example 2:

--

-- -- Unix variants

-- info = pathinfo("/opt/euphoria/docs/readme.txt")

-- -- info is {"/opt/euphoria/docs", "readme.txt", "readme", "txt", ""}

--

--

-- Example 3:

--

-- -- no extension

-- info = pathinfo("/opt/euphoria/docs/readme")

-- -- info is {"/opt/euphoria/docs", "readme", "readme", "", ""}

--

--

-- See Also:

-- [[:driveid]], [[:dirname]], [[:filename]], [[:fileext]],

-- [[:PATH_BASENAME]], [[:PATH_DIR]], [[:PATH_DRIVEID]], [[:PATH_FILEEXT]],

-- [[:PATH_FILENAME]]

integer slash, period, ch

sequence dir_name, file_name, file_ext, file_full, drive_id

end if

ch = eu:find(':', dir_name)

if ch != 0 then

drive_id = dir_name[1..ch-1]

dir_name = dir_name[ch+1..$]

end if

end ifdef

end if

else

end if

elsedef

sequence from_slash = "/"

end ifdef

else

end if

end if

end function

--**

-- Return the directory name of a fully qualified filename

--

-- Parameters:

-- # ##path## : the path from which to extract information

-- # ##pcd## : If not zero and there is no directory name in ##path##

-- then "." is returned. The default (0) will just return

-- any directory name in ##path##.

--

-- Returns:

-- A **sequence**, the full file name part of ##path##.

--

-- Comments:

-- The host operating system path separator is used.

--

-- Example 1:

--

-- fname = dirname("/opt/euphoria/docs/readme.txt")

-- -- fname is "/opt/euphoria/docs"

--

--

-- See Also:

-- [[:driveid]], [[:filename]], [[:pathinfo]]

sequence data

end if

end if

end function

--**

-- Return the file name portion of a fully qualified filename

--

-- Parameters:

-- # ##path## : the path from which to extract information

--

-- Returns:

-- A **sequence**, the file name part of ##path##.

--

-- Comments:

-- The host operating system path separator is used.

--

-- Example 1:

--

-- fname = filename("/opt/euphoria/docs/readme.txt")

-- -- fname is "readme.txt"

--

--

-- See Also:

-- [[:pathinfo]], [[:filebase]], [[:fileext]]

sequence data

end function

--**

-- Return the base filename of path.

--

-- Parameters:

-- # ##path## : the path from which to extract information

--

-- Returns:

-- A **sequence**, the base file name part of ##path##.

--

-- TODO: Test

--

-- Example 1:

--

-- base = filebase("/opt/euphoria/readme.txt")

-- -- base is "readme"

--

--

-- See Also:

-- [[:pathinfo]], [[:filename]], [[:fileext]]

sequence data

end function

--**

-- Return the file extension of a fully qualified filename

--

-- Parameters:

-- # ##path## : the path from which to extract information

--

-- Returns:

-- A **sequence**, the file extension part of ##path##.

--

-- Comments:

-- The host operating system path separator is used.

--

-- Example 1:

--

-- fname = fileext("/opt/euphoria/docs/readme.txt")

-- -- fname is "txt"

--

--

-- See Also:

-- [[:pathinfo]], [[:filename]], [[:filebase]]

sequence data

end function

--**

-- Return the drive letter of the path on //WIN32// platforms.

--

-- Parameters:

-- # ##path## : the path from which to extract information

--

-- Returns:

-- A **sequence**, the file extension part of ##path##.

--

-- TODO: Test

--

-- Example:

--

-- letter = driveid("C:\\EUPHORIA\\Readme.txt")

-- -- letter is "C"

--

--

-- See Also:

-- [[:pathinfo]], [[:dirname]], [[:filename]]

sequence data

end function

--**

-- Returns the supplied filepath with the supplied extension, if

-- the filepath does not have an extension already.

--

-- Parameters:

-- # ##path## : the path to check for an extension.

-- # ##defext## : the extension to add if ##path## does not have one.

--

-- Returns:

-- A **sequence**, the path with an extension.

--

-- Example:

--

-- -- ensure that the supplied path has an extension, but if it doesn't use "tmp".

-- theFile = defaultext(UserFileName, "tmp")

--

--

-- See Also:

-- [[:pathinfo]]

end if

-- There is a dot in the file name part

end if

-- No file name in supplied path

else

-- No dot in file name part.

end if

end if

end if

end function

--**

-- Determine if the supplied string is an absolute path or a relative path.

--

-- Parameters:

-- # ##filename## : a sequence, the name of the file path

--

-- Returns:

-- An **integer**, 0 if ##filename## is a relative path or 1 otherwise.

--

-- Comment:

-- A //relative// path is one which is relative to the current directory and

-- an //absolute// path is one that doesn't need to know the current directory

-- to find the file.

--

-- Example 1:

--

-- ? absolute_path("") -- returns 0

-- ? absolute_path("/usr/bin/abc") -- returns 1

-- ? absolute_path("\\temp\\somefile.doc") -- returns 1

-- ? absolute_path("../abc") -- returns 0

-- ? absolute_path("local/abc.txt") -- returns 0

-- ? absolute_path("abc.txt") -- returns 0

-- ? absolute_path("c:..\\abc") -- returns 0

-- -- The next two examples return 0 on Unix platforms and 1 on Microsoft platforms

-- ? absolute_path("c:\\windows\\system32\\abc")

-- ? absolute_path("c:/windows/system32/abc")

--

end if

end if

if length(filename) = 1 then

return 0

end if

if filename[2] != ':' then

return 0

end if

if length(filename) < 3 then

return 0

end if

if eu:find(filename[3], SLASHES) then

return 1

end if

end ifdef

end function

--**

-- Returns the full path and file name of the supplied file name.

--

-- Parameters:

-- # ##path_in## : A sequence. This is the file name whose full path you want.

-- # ##directory_given## : An integer. This is zero if ##path_in## is

-- to be interpreted as a file specification otherwise it is assumed to be a

-- directory specification. The default is zero.

-- # ##no_case## : An integer. Only applies to the Windows platform. If zero (the default)

-- the path name is returned exactly as stored in the file system, otherwise the

-- returned value is all in lowercase.

--

-- Returns:

-- A **sequence**, the full path and file name.

--

-- Comment:

-- * In non-Unix systems, the result is always in lowercase.

-- * The supplied file/directory does not have to actually exist.

-- * Does not (yet) handle UNC paths or unix links.

--

--

-- Example 1:

--

-- -- Assuming the current directory is "/usr/foo/bar"

-- res = canonical_path("../abc.def")

-- -- res is now "/usr/foo/abc.def"

--

sequence lHome

elsedef

sequence lDrive = ""

-- Replace unix style separators with Windows style

lPath = match_replace("/", path_in, SLASH)

end ifdef

-- Strip off any enclosing quotes.

end if

-- Replace any leading tilde with 'HOME' directory.

elsedef

lHome = getenv("HOMEDRIVE") & getenv("HOMEPATH")

end ifdef

end if

else

end if

end if

-- Strip off any drive letter attached.

if ( (length(lPath) > 1) and (lPath[2] = ':' ) )

then

lDrive = lPath[1..2]

lPath = lPath[3..$]

end if

end ifdef

-- If a relative path, prepend the PWD of the appropriate drive.

then

elsedef

if (length(lDrive) = 0) then

lPath = curdir() & lPath

else

lPath = curdir(lDrive[1]) & lPath

end if

-- Strip of the drive letter if it got attached again.

if ( (length(lPath) > 1) and (lPath[2] = ':' ) ) then

if (length(lDrive) = 0) then

lDrive = lPath[1..2]

end if

lPath = lPath[3..$]

end if

end ifdef

end if

-- If the input is supposed to be a directory, ensure it ends in a path separator.

end if

-- Replace all instances of "/./" with "/"

entry

-- Replace all instances of "X/Y/../" with "X/"

-- Locate preceding directory separator.

end if

entry

lPath = lDrive & lPath

if no_case then

lPath = lower(lPath)

end if

end ifdef

end function

--****

-- === File Types

public enum

--**

-- Get the type of a file.

--

-- Parameters:

-- # ##filename## : the name of the file to query. It must not have wildcards.

--

-- Returns:

-- An **integer**,