const type: tarArchive

FileSys implementation type to access a TAR archive. File paths in a TAR archive can be absolute (they start with a slash) or relative (they do not start with a slash). The tar file system does not support the concept of a current working directory. The functions chdir and getcwd are not supported by the tar file system. Absolute and relative paths in a TAR archive can be accessed directly. Since "/" is just a normal path in a TAR archive the root path of a tar file system is "". Possible usages of tar file system functions are:

 getMTime(aTarArchive, "src/drivers")   # Relative path in the archive.
 fileType(aTarArchive, "/usr/include")  # Absolute path in the archive.
 fileSize(aTarArchive, "/image")        # Absolute path in the archive.
 readDir(aTarArchive, "")               # Return e.g.: "src" and "/"
 readDir(aTarArchive, "/")              # Return e.g.: "usr" and "image"

const func fileSys: openTar (inout file: tarFile)

Open a TAR archive with the given tarFile.

Parameters:

tarFile - File that contains a TAR archive.

Returns:

a file system that accesses the TAR archive, or fileSys.value if it could not be opened.

const func fileSys: openTar (in string: tarFileName)

Open a TAR archive with the given tarFileName.

Parameters:

tarFileName - Name of the TAR archive to be opened.

Returns:

a file system that accesses the TAR archive, or fileSys.value if it could not be opened.

const proc: close (inout tarArchive: tar)

Close a TAR archive. The TAR file below stays open.

const func array string: readDir (inout tarArchive: tar, in string: dirPath)

Determine the file names in a directory inside a TAR archive. Note that the function returns only the file names. Additional information must be obtained with other calls.

Parameters:

tar - Open TAR archive.

dirPath - Path of a directory in the TAR archive.

Returns:

an array with the file names.

Raises:

RANGE_ERROR - dirPath does not use the standard path representation.

FILE_ERROR - dirPath is not present in the TAR archive.

const func array string: readDir (inout tarArchive: tar, RECURSIVE)

Determine the file paths in a TAR archive. Note that the function returns only the file paths. Additional information must be obtained with other calls.

Parameters:

tar - Open TAR archive.

Returns:

an array with the file paths.

const func fileType: fileType (inout tarArchive: tar, in var string: filePath)

Determine the type of a file in a TAR archive. The function follows symbolic links. If the chain of symbolic links is too long the function returns FILE_SYMLINK. A return value of FILE_ABSENT does not imply that a file with this name can be created, since missing directories and invalid file names cause also FILE_ABSENT.

Returns:

the type of the file.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

const func fileType: fileTypeSL (inout tarArchive: tar, in string: filePath)

Determine the type of a file in a TAR archive. The function does not follow symbolic links. Therefore it may return FILE_SYMLINK. A return value of FILE_ABSENT does not imply that a file with this name can be created, since missing directories and invalid file names cause also FILE_ABSENT.

Returns:

the type of the file.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

const func fileMode: getFileMode (inout tarArchive: tar, in string: filePath)

Determine the file mode (permissions) of a file in a TAR archive. The function follows symbolic links.

Returns:

the file mode.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const proc: setFileMode (inout tarArchive: tar, in string: filePath, in fileMode: mode)

Change the file mode (permissions) of a file in a TAR archive. The function follows symbolic links.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const func integer: fileSize (inout tarArchive: tar, in string: filePath)

Determine the size of a file in a TAR archive. The file size is measured in bytes. For directories a size of 0 is returned. The function follows symbolic links.

Returns:

the size of the file.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const func time: getMTime (inout tarArchive: tar, in string: filePath)

Determine the modification time of a file in a TAR archive. The function follows symbolic links.

Returns:

the modification time of the file.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const proc: setMTime (inout tarArchive: tar, in string: filePath, in time: modificationTime)

Set the modification time of a file in a TAR archive. The function follows symbolic links.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

RANGE_ERROR - modificationTime is invalid or cannot be converted to the system file time.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const func string: getOwner (inout tarArchive: tar, in string: filePath)

Determine the name of the owner (UID) of a file in a TAR archive. The function follows symbolic links.

Returns:

the name of the file owner.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const proc: setOwner (inout tarArchive: tar, in string: filePath, in string: owner)

Set the owner of a file in a TAR archive. The function follows symbolic links.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const func string: getGroup (inout tarArchive: tar, in string: filePath)

Determine the name of the group (GID) of a file in a TAR archive. The function follows symbolic links.

Returns:

the name of the file group.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const proc: setGroup (inout tarArchive: tar, in string: filePath, in string: group)

Set the group of a file in a TAR archive. The function follows symbolic links.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or the chain of symbolic links is too long.

const func fileMode: getFileMode (inout tarArchive: tar, in string: filePath, SYMLINK)

Determine the file mode (permissions) of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Returns:

the file mode.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const func time: getMTime (inout tarArchive: tar, in string: filePath, SYMLINK)

Determine the modification time of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Returns:

the modification time of the symbolic link.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const proc: setMTime (inout tarArchive: tar, in string: filePath, in time: modificationTime, SYMLINK)

Set the modification time of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

RANGE_ERROR - modificationTime is invalid or it cannot be converted to the system file time.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const func string: getOwner (inout tarArchive: tar, in string: filePath, SYMLINK)

Determine the name of the owner (UID) of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Returns:

the name of the file owner.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const proc: setOwner (inout tarArchive: tar, in string: filePath, in string: owner, SYMLINK)

Set the owner of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const func string: getGroup (inout tarArchive: tar, in string: filePath, SYMLINK)

Determine the name of the group (GID) of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Returns:

the name of the file group.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const proc: setGroup (inout tarArchive: tar, in string: filePath, in string: group, SYMLINK)

Set the group of a symbolic link in a TAR archive. The function only works for symbolic links and does not follow the symbolic link.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file described with filePath is not present in the TAR archive, or it is not a symbolic link.

const func string: readLink (inout tarArchive: tar, in string: filePath)

Reads the destination of a symbolic link in a TAR archive.

Returns:

The destination referred by the symbolic link.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or is not a symbolic link.

const proc: makeLink (inout tarArchive: tar, in string: symlinkPath, in string: targetPath)

Create a symbolic link in a TAR archive. The symbolic link symlinkPath will refer to targetPath afterwards. The function does not follow symbolic links.

Parameters:

tar - Open TAR archive.

symlinkPath - Name of the symbolic link to be created.

targetPath - String to be contained in the symbolic link.

Raises:

RANGE_ERROR - targetPath or symlinkPath does not use the standard path representation.

FILE_ERROR - A system function returns an error.

const func string: getFile (inout tarArchive: tar, in string: filePath)

Get the contents of a file in a TAR archive. The function follows symbolic links.

Returns:

the specified file as string.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - filePath is not present in the TAR archive, or is not a regular file, or the chain of symbolic links is too long.

const proc: putFile (inout tarArchive: tar, in var string: filePath, in string: data)

Write data to a TAR archive with the given filePath. If the file exists already, it is overwritten. The function follows symbolic links.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file exists, but it is not a regular file.

const proc: makeDir (inout tarArchive: tar, in string: dirPath)

Create a new directory in a TAR archive. The function does not follow symbolic links.

Parameters:

tar - Open TAR archive.

dirPath - Name of the directory to be created.

Raises:

RANGE_ERROR - dirPath does not use the standard path representation.

FILE_ERROR - The file dirPath already exists.

const proc: removeFile (inout tarArchive: tar, in string: filePath)

Remove any file except non-empty directories from a TAR archive. The function does not follow symbolic links. An attempt to remove a directory that is not empty triggers FILE_ERROR.

Parameters:

tar - Open TAR archive.

filePath - Name of the file to be removed.

Raises:

RANGE_ERROR - filePath does not use the standard path representation.

FILE_ERROR - The file does not exist or it is a directory that is not empty.

const proc: for (inout string: filePath) range (inout tarArchive: tar) do (in proc: statements) end for

For-loop which loops recursively over the paths in a TAR archive.

const func file: open (inout tarArchive: tar, in string: filePath, in string: mode)

Open a file with filePath and mode in in a TAR archive.