/usr/lib/ocaml/optcomp/pa_optcomp.mli is in liboptcomp-camlp4-dev 1.6-1.
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 | (*
* pa_optcomp.mli
* --------------
* Copyright : (c) 2011, Jeremie Dimino <jeremie@dimino.org>
* Licence : BSD3
*
* This file is a part of optcomp.
*)
(** Optionnal compilation with cpp-like directives *)
open Camlp4.PreCast
(** Representation of values supported by optcomp. *)
type value =
| Bool of bool
| Int of int
| Char of char
| String of string
| Tuple of value list
module Env : Map.S with type key = string
(** Mapping from strings. *)
type env = value Env.t
(** Type of environments. *)
val env : env ref
(** The global environment. *)
val define : string -> value -> unit
(** [define id value] binds [id] to [value] in the global
environment. *)
val eval : env -> Ast.expr -> value
(** [eval env expr] tries to evalute [expr] in [env]. It raises
[Failure] if the expression cannot be statically evaluated. *)
val string_of_value_o : value -> string
(** Returns a string representation of the given value, in original
syntax. *)
val string_of_value_r : value -> string
(** Returns a string representation of the given value, in revised
syntax. *)
val default_lexer : string -> in_channel -> (Token.t * Loc.t) Stream.t
(** The default lexer. It returns a filtered token stream. *)
val filter : ?lexer : (string -> in_channel -> (Token.t * Loc.t) Stream.t) -> Token.Filter.token_filter
(** The optcomp stream filter. [lexer] is the lexer to use for
included files. Its default value is {!default_lexer}. *)
val get_quotation_value : string -> value
(** [get_quotation_value id] returns the value registered for the
given quotation.
After filtering a token stream, optcomp quotations contents are
replaced by identifiers, this function returns the value
assocaited to a given quotation identifier. *)
val expr_of_value : Loc.t -> value -> Ast.expr
(** [expr_of_value loc value] converts a value to an expression. *)
val patt_of_value : Loc.t -> value -> Ast.patt
(** [patt_of_value loc value] converts a value to a pattern. *)
|