ocaml/stdlib/filename.mli

(***********************************************************************)
(*                                                                     *)
(*                           Objective Caml                            *)
(*                                                                     *)
(*            Xavier Leroy, projet Cristal, INRIA Rocquencourt         *)
(*                                                                     *)
(*  Copyright 1996 Institut National de Recherche en Informatique et   *)
(*  en Automatique.  All rights reserved.  This file is distributed    *)
(*  under the terms of the GNU Library General Public License.         *)
(*                                                                     *)
(***********************************************************************)

(* $Id$ *)

(* Module [Filename]: operations on file names *)

val current_dir_name : string
        (* The conventional name for the current directory
           (e.g. [.] in Unix). *)
val parent_dir_name : string
        (* The conventional name for the parent of the current directory
           (e.g. [..] in Unix). *)
val concat : string -> string -> string
        (* [concat dir file] returns a file name that designates file
           [file] in directory [dir]. *)
val is_relative : string -> bool
        (* Return [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 -> bool
        (* Return [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 -> bool
        (* [check_suffix name suff] returns [true] if the filename [name]
           ends with the suffix [suff]. *)
val chop_suffix : string -> string -> string
        (* [chop_suffix name suff] removes the suffix [suff] from
           the filename [name]. The behavior is undefined if [name] does not
           end with the suffix [suff]. *)
val chop_extension : string -> string
        (* Return the given file name without its extension. The extension
           is the shortest suffix starting with a period, [.xyz] for instance.
           Raise [Invalid_argument] if the given name does not contain
           a period. *)
val basename : string -> string
val dirname : string -> string
        (* Split a file name into directory name / base file name.
           [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]. *)
val temp_file : prefix:string -> suffix:string -> string
        (* [temp_file prefix suffix] returns the name of a
           non-existent 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].
           Under Unix, the temporary directory is [/tmp] by default; if set,
           the value of the environment variable [TMPDIR] is used instead.
           Under Windows, the name of the temporary directory is the
           value of the environment variable [TEMP],
           or [C:\temp] by default.
           Under MacOS, the name of the temporary directory is given
           by the environment variable [TempFolder]; if not set,
           temporary files are created in the current directory. *)
val quote : string -> string;;
        (* Return a quoted version of a file name, suitable for use as
           one argument in a shell command line, escaping any shell
           meta-characters. *)