libmojave/stdlib/lm_file_util.mli

   1 (*
   2  * Operations on files.
   3  *
   4  * ----------------------------------------------------------------
   5  *
   6  * This file is part of MetaPRL, a modular, higher order
   7  * logical framework that provides a logical programming
   8  * environment for OCaml and other languages.
   9  *
  10  * See the file doc/htmlman/default.html or visit http://metaprl.org/
  11  * for more information.
  12  *
  13  * Copyright (C) 1998-2005 PRL Group, Cornell University and Caltech
  14  *
  15  * This library is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU Lesser General Public
  17  * License as published by the Free Software Foundation,
  18  * version 2.1 of the License.
  19  *
  20  * This library is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  * Lesser General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU Lesser General Public
  26  * License along with this library; if not, write to the Free Software
  27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  28  *
  29  * Additional permission is given to link this library with the
  30  * OpenSSL project's "OpenSSL" library, and with the OCaml runtime,
  31  * and you may distribute the linked executables.  See the file
  32  * LICENSE.libmojave for more details.
  33  *
  34  * Author: Jason Hickey
  35  * jyh@cs.cornell.edu
  36  *)
  37
  38 (* Can't open and can't find a file *)
  39 exception CantOpen of string
  40 exception CantFind of string
  41
  42 (*
  43  * Utilities on filenames.
  44  *)
  45 val parse_path : string list -> string -> string list
  46 val build_path : string list -> string
  47 val path_dir : string -> string
  48 val path_file : string -> string
  49
  50 (*
  51  * Open a file somewhere in the path if possible.
  52  *)
  53 val open_in_path : string list -> string -> in_channel * string
  54
  55 (*
  56  * Safe file handling.
  57  * the files are closed on exception.
  58  *)
  59 val with_input_file : string -> (in_channel -> 'a) -> 'a
  60 val with_output_file : string -> (out_channel -> 'a) -> 'a
  61
  62 (*
  63  * -*-
  64  * Local Variables:
  65  * Caml-master: "refiner"
  66  * End:
  67  * -*-
  68  *)