Pack prolog_library_collection -- prolog/file

The following predicates are exported from this file while their implementation is defined in imported modules or non-module files loaded by this module.

set_time_file(+File, -OldTimes, +NewTimes) is det

Query and set POSIX time attributes of a file. Both OldTimes and NewTimes are lists of option-terms. Times are represented in SWI-Prolog's standard floating point numbers. New times may be specified as now to indicate the current time. Defined options are:

access(Time): Describes the time of last access of the file. This value can be read and written.
modified(Time): Describes the time the contents of the file was last modified. This value can be read and written.
changed(Time): Describes the time the file-structure itself was changed by adding (link()) or removing (unlink()) names.

Below are some example queries. The first retrieves the access-time, while the second sets the last-modified time to the current time.

?- set_time_file(foo, [access(Access)], []).
?- set_time_file(foo, [], [modified(now)]).

link_file(+OldPath, +NewPath, +Type) is det

Create a link in the filesystem from NewPath to OldPath. Type defines the type of link and is one of hard or symbolic.

With some limitations, these functions also work on Windows. First of all, the underlying filesystem must support links. This requires NTFS. Second, symbolic links are only supported in Vista and later.

Errors: - domain_error(link_type, Type) if the requested link-type is unknown or not supported on the target OS.

relative_file_name(+Path:atom, +RelToFile:atom, -RelPath:atom) is det

relative_file_name(-Path:atom, +RelToFile:atom, +RelPath:atom) is det

True when RelPath is Path, relative to the file RelToFile. Path and RelTo are first handed to absolute_file_name/2, which makes the absolute and canonical. Below are two examples:

?- relative_file_name('/home/janw/nice',
                      '/home/janw/deep/dir/file', Path).
Path = '../../nice'.

?- relative_file_name(Path, '/home/janw/deep/dir/file', '../../nice').
Path = '/home/janw/nice'.

Add a terminating / to get a path relative to a directory, e.g.

?- relative_file_name('/home/janw/deep/dir/file', './', Path).
Path = 'deep/dir/file'.

Arguments:

All

- paths must be in canonical POSIX notation, i.e., using / to separate segments in the path. See prolog_to_os_filename/2.

bug

- It would probably have been cleaner to use a directory as second argument. We can not do such dynamically as this predicate is defined as a syntactical operation, which implies it may be used for non-existing paths and URLs.

directory_file_path(+Directory, +File, -Path) is det

directory_file_path(?Directory, ?File, +Path) is det

True when Path is the full path-name for File in Dir. This is comparable to atom_concat(Directory, File, Path), but it ensures there is exactly one / between the two parts. Notes:

In mode (+,+,-), if File is given and absolute, Path is unified to File.
Mode (-,-,+) uses file_directory_name/2 and file_base_name/2

directory_member(+Directory, -Member, +Options) is nondet

True when Member is a path inside Directory. Options defined are:

recursive(+Boolean): If true (default false), recurse into subdirectories
follow_links(+Boolean): If true (default), follow symbolic links.
file_type(+Type): See absolute_file_name/3.
extensions(+List): Only return entries whose extension appears in List.
file_errors(+Errors): How to handle errors. One of fail, warning or error. Default is warning. Errors notably happen if a directory is unreadable or a link points nowhere.
access(+Access): Only return entries with Access
matches(+GlobPattern): Only return files that match GlobPattern.
exclude(+GlobPattern): Exclude files matching GlobPattern.
exclude_directory(+GlobPattern): Do not recurse into directories matching GlobPattern.
hidden(+Boolean): If true (default), also return hidden files.

This predicate is safe against cycles introduced by symbolic links to directories.

The idea for a non-deterministic file search predicate comes from Nicos Angelopoulos.

copy_file(+From, +To) is det

Copy a file into a new file or directory. The data is copied as binary data.

make_directory_path(+Dir) is det

Create Dir and all required components (like mkdir -p). Can raise various file-specific exceptions.

ensure_directory(+Dir) is det

Ensure the directory Dir exists. Similar to make_directory_path/1, but creates at most one new directory, i.e., the directory or its direct parent must exist.

copy_directory(+From, +To) is det

Copy the contents of the directory From to To (recursively). If To is the name of an existing directory, the contents of From are copied into To. I.e., no subdirectory using the basename of From is created.

delete_directory_and_contents(+Dir) is det

Recursively remove the directory Dir and its contents. If Dir is a symbolic link or symbolic links inside Dir are encountered, the links are removed rather than their content. Use with care!

delete_directory_contents(+Dir) is det

Remove all content from directory Dir, without removing Dir itself. Similar to delete_directory_and_contents/2, if symbolic links are encountered in Dir, the links are removed rather than their content.

chmod(+File, +Spec) is det

Set the mode of the target file. Spec is one of +Mode, -Mode or a plain Mode, which adds new permissions, revokes permissions or sets the exact permissions. Mode itself is an integer, a POSIX mode name or a list of POSIX mode names. Defines names are suid, sgid, svtx and all names defined by the regular expression [ugo]*[rwx]*. Specifying none of "ugo" is the same as specifying all of them. For example, to make a file executable for the owner (user) and group, we can use:

?- chmod(myfile, +ugx).

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.

compress_file(Arg1, Arg2)
convert_file(Arg1, Arg2, Arg3)
delete_files_by_extension(Arg1, Arg2)
delete_files_by_extensions(Arg1, Arg2)
directory_file(Arg1, Arg2)
read_from_file(Arg1, Arg2, Arg3)
read_write_file(Arg1, Arg2, Arg3)
read_write_file(Arg1, Arg2, Arg3, Arg4)
read_write_files(Arg1, Arg2, Arg3, Arg4)
read_write_files(Arg1, Arg2, Arg3, Arg4, Arg5)
recode_file(Arg1, Arg2)
recode_files(Arg1, Arg2, Arg3)
sort_file(Arg1, Arg2)
write_to_file(Arg1, Arg2, Arg3)
copy_stream_type(Arg1, Arg2)
guess_encoding(Arg1, Arg2)
number_of_open_files(Arg1)
read_line_to_atom(Arg1, Arg2)
read_line_to_number(Arg1, Arg2)
read_stream_to_atom(Arg1, Arg2)
read_stream_to_string(Arg1, Arg2)
recode_stream(Arg1, Arg2, Arg3)
stream_line(Arg1, Arg2)
stream_line_column(Arg1, Arg2, Arg3)
stream_metadata(Arg1, Arg2)
wc(Arg1, Arg2)