module Filename:sig..end
Operations on file names.
val current_dir_name : stringThe conventional name for the current directory (e.g. . in Unix).
val parent_dir_name : stringThe conventional name for the parent of the current directory
(e.g. .. in Unix).
val dir_sep : stringThe directory separator (e.g. / in Unix).
val concat : string -> string -> stringconcat dir file returns a file name that designates file
file in directory dir.
val is_relative : string -> boolReturn true if the file name is relative to the current
directory, false if it is absolute (i.e. in Unix, starts
with /).
val is_implicit : string -> boolReturn true if the file name is relative and does not start
with an explicit reference to the current directory (./ or
../ in Unix), false if it starts with an explicit reference
to the root directory or the current directory.
val check_suffix : string -> string -> boolcheck_suffix name suff returns true if the filename name
ends with the suffix suff.
Under Windows ports (including Cygwin), comparison is
case-insensitive, relying on String.lowercase_ascii. Note that
this does not match exactly the interpretation of case-insensitive
filename equivalence from Windows.
val chop_suffix : string -> string -> stringchop_suffix name suff removes the suffix suff from
the filename name. The behavior is undefined if name does not
end with the suffix suff. chop_suffix_opt is thus recommended
instead.
val chop_suffix_opt : suffix:string -> string -> string optionchop_suffix_opt ~suffix filename removes the suffix from
the filename if possible, or returns None if the
filename does not end with the suffix.
Under Windows ports (including Cygwin), comparison is
case-insensitive, relying on String.lowercase_ascii. Note that
this does not match exactly the interpretation of case-insensitive
filename equivalence from Windows.
val extension : string -> stringextension name is the shortest suffix ext of name0 where:
name0 is the longest suffix of name that does not
contain a directory separator;ext starts with a period;ext is preceded by at least one non-period character
in name0.If such a suffix does not exist, extension name is the empty
string.
val remove_extension : string -> stringReturn the given file name without its extension, as defined
in Filename.extension. If the extension is empty, the function
returns the given file name.
The following invariant holds for any file name s:
remove_extension s ^ extension s = s
val chop_extension : string -> stringSame as Filename.remove_extension, but raise Invalid_argument
if the given name has an empty extension.
val basename : string -> stringSplit a file name into directory name / base file name.
If name is a valid file name, then concat (dirname name) (basename name)
returns a file name which is equivalent to name. Moreover,
after setting the current directory to dirname name (with Sys.chdir),
references to basename name (which is a relative file name)
designate the same file as name before the call to Sys.chdir.
This function conforms to the specification of POSIX.1-2008 for the
basename utility.
val dirname : string -> stringSee Filename.basename.
This function conforms to the specification of POSIX.1-2008 for the
dirname utility.
val temp_file : ?temp_dir:string -> string -> string -> stringtemp_file prefix suffix returns the name of a
fresh temporary file in the temporary directory.
The base name of the temporary file is formed by concatenating
prefix, then a suitably chosen integer number, then suffix.
The optional argument temp_dir indicates the temporary directory
to use, defaulting to the current result of Filename.get_temp_dir_name.
The temporary file is created empty, with permissions 0o600
(readable and writable only by the file owner). The file is
guaranteed to be different from any other file that existed when
temp_file was called.
Raise Sys_error if the file could not be created.
val open_temp_file : ?mode:open_flag list ->
?perms:int ->
?temp_dir:string -> string -> string -> string * out_channelSame as Filename.temp_file, but returns both the name of a fresh
temporary file, and an output channel opened (atomically) on
this file. This function is more secure than temp_file: there
is no risk that the temporary file will be modified (e.g. replaced
by a symbolic link) before the program opens it. The optional argument
mode is a list of additional flags to control the opening of the file.
It can contain one or several of Open_append, Open_binary,
and Open_text. The default is [Open_text] (open in text mode). The
file is created with permissions perms (defaults to readable and
writable only by the file owner, 0o600).
Sys_error if the file could not be opened.val get_temp_dir_name : unit -> stringThe name of the temporary directory:
Under Unix, the value of the TMPDIR environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the TEMP environment variable, or "."
if the variable is not set.
The temporary directory can be changed with Filename.set_temp_dir_name.
val set_temp_dir_name : string -> unitChange the temporary directory returned by Filename.get_temp_dir_name
and used by Filename.temp_file and Filename.open_temp_file.
val temp_dir_name : stringFilename.get_temp_dir_name instead.The name of the initial temporary directory:
Under Unix, the value of the TMPDIR environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the TEMP environment variable, or "."
if the variable is not set.
val quote : string -> stringReturn a quoted version of a file name, suitable for use as one argument in a command line, escaping all meta-characters. Warning: under Windows, the output is only suitable for use with programs that follow the standard Windows quoting conventions.