/usr/lib/ocaml/oasis/BaseEnv.mli is in liboasis-ocaml-dev 0.4.10-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | (******************************************************************************)
(* OASIS: architecture for building OCaml libraries and applications *)
(* *)
(* Copyright (C) 2011-2016, Sylvain Le Gall *)
(* Copyright (C) 2008-2011, OCamlCore SARL *)
(* *)
(* This library is free software; you can redistribute it and/or modify it *)
(* under the terms of the GNU Lesser General Public License as published by *)
(* the Free Software Foundation; either version 2.1 of the License, or (at *)
(* your option) any later version, with the OCaml static compilation *)
(* exception. *)
(* *)
(* This library is distributed in the hope that it will be useful, but *)
(* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *)
(* or FITNESS FOR A PARTICULAR PURPOSE. See the file COPYING for more *)
(* details. *)
(* *)
(* You should have received a copy of the GNU Lesser General Public License *)
(* along with this library; if not, write to the Free Software Foundation, *)
(* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *)
(******************************************************************************)
(** Read-write access to 'setup.data'
@author Sylvain Le Gall
*)
open OASISTypes
(** Origin of the variable, if a variable has been already set
with a higher origin, it won't be set again.
*)
type origin_t =
| ODefault (** Default computed value. *)
| OGetEnv (** Extracted from environment, using Sys.getenv. *)
| OFileLoad (** From loading file setup.data. *)
| OCommandLine (** Set on command line. *)
(** Command line handling for variable. *)
type cli_handle_t =
| CLINone
(** No command line argument. *)
| CLIAuto
(** Build using variable name and help text. *)
| CLIWith
(** Use prefix --with-. *)
| CLIEnable
(** Use --enable/--disable. *)
| CLIUser of (Arg.key * Arg.spec * Arg.doc) list
(** Fully define the command line arguments. *)
(** Variable type. *)
type definition_t =
{
hide: bool; (** Hide the variable. *)
dump: bool; (** Dump the variable. *)
cli: cli_handle_t; (** Command line handling for the variable. *)
arg_help: string option; (** Help about the variable. *)
group: name option; (** Group of the variable. *)
}
(** Schema for environment. *)
val schema: (origin_t, definition_t) PropList.Schema.t
(** Data for environment. *)
val env: PropList.Data.t
(** Expand variable that can be found in string. Variable follow definition of
variable for [Buffer.add_substitute].
*)
val var_expand: string -> string
(** Get variable. *)
val var_get: name -> string
(** Choose a value among conditional expressions. *)
val var_choose:
?printer:('a -> string) ->
?name:string ->
'a OASISExpr.choices ->
'a
(** Protect a variable content, to avoid expansion. *)
val var_protect: string -> string
(** Define a variable. *)
val var_define:
?hide:bool ->
?dump:bool ->
?short_desc:(unit -> string) ->
?cli:cli_handle_t ->
?arg_help:string ->
?group:string ->
name ->
(unit -> string) ->
(unit -> string)
(** Define a variable or redefine it. *)
val var_redefine:
?hide:bool ->
?dump:bool ->
?short_desc:(unit -> string) ->
?cli:cli_handle_t ->
?arg_help:string ->
?group:string ->
name ->
(unit -> string) ->
(unit -> string)
(** Well-typed ignore for [var_define]. *)
val var_ignore: (unit -> string) -> unit
(** Display all variables, even hidden one. *)
val print_hidden: unit -> string
(** Get all variables. *)
val var_all: unit -> name list
(** Environment default file. *)
val default_filename: OASISContext.source_filename
(** Initialize environment. *)
val load:
ctxt:OASISContext.t ->
?allow_empty:bool ->
?filename:OASISContext.source_filename ->
unit ->
unit
(** Uninitialize environment. *)
val unload: unit -> unit
(** Save environment on disk. *)
val dump:
ctxt:OASISContext.t ->
?filename:OASISContext.source_filename ->
unit ->
unit
(** Display environment to user. *)
val print: unit -> unit
(** Default command line arguments, computed using variable definitions. *)
val args: unit -> (Arg.key * Arg.spec * Arg.doc) list
|