libmojave/unix/lm_unix_util.mli

   1 (*
   2  * Extra unix utilities.
   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-2007 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 <jyh@cs.cornell.edu>
  35  * Modified By: Aleksey Nogin <anogin@hrl.com>
  36  *)
  37
  38 (*
  39  * Print the location of the stack pointer for debugging.
  40  *)
  41 val print_stack_pointer : unit -> unit
  42
  43 (*
  44  * Location of the home directory.
  45  *)
  46 val home_dir : string
  47
  48 (*
  49  * Location of application data (this is the same as home_dir
  50  * except on Win32).
  51  *)
  52 val application_dir : string
  53
  54 (*
  55  * Really read some number of bytes.
  56  *)
  57 val really_read : Unix.file_descr -> string -> int -> int -> unit
  58
  59 (*
  60  * Copy an entire file.
  61  *)
  62 val copy_file : string -> string -> int -> unit
  63
  64 (*
  65  * Make all the directories in a path.
  66  *)
  67 val mkdirhier : string -> unit
  68
  69 (*
  70  * Home directory of the current user.
  71  *)
  72 val home_dir : string
  73
  74 (*
  75  * C interface.
  76  *)
  77 val int_of_fd : Unix.file_descr -> int
  78
  79 (*
  80  * Lock utilities.
  81  *)
  82 val lockf : Unix.file_descr -> Unix.lock_command -> int -> unit
  83
  84 (*
  85  * File truncation.
  86  *)
  87 val ftruncate : Unix.file_descr -> unit
  88
  89 (*
  90  * Get a value from the registry.
  91  * raises Not_found if the entry is not found or you are not using Win32.
  92  *)
  93 type registry_hkey =
  94     HKEY_CLASSES_ROOT
  95   | HKEY_CURRENT_CONFIG
  96   | HKEY_CURRENT_USER
  97   | HKEY_LOCAL_MACHINE
  98   | HKEY_USERS
  99
 100 val registry_find  : registry_hkey -> string -> string -> string
 101
 102 (*
 103  * Open a file.
 104  * This is mainly for debugging.
 105  *)
 106 val openfile : string -> Unix.open_flag list -> Unix.file_perm -> Unix.file_descr
 107
 108 (*
 109  * Simple file locking.
 110  *)
 111 type flock_command =
 112    LOCK_UN
 113  | LOCK_SH
 114  | LOCK_EX
 115  | LOCK_TSH
 116  | LOCK_TEX
 117
 118 val flock : Unix.file_descr -> flock_command -> unit
 119
 120 (*
 121  * Scan the password database for entries.
 122  *)
 123 val getpwents : unit -> Unix.passwd_entry list
 124
 125 (*
 126  * -*-
 127  * Local Variables:
 128  * End:
 129  * -*-
 130  *)