env.mli 3.38 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
(**************************************************************************)
(*                                                                        *)
(*  Copyright (C) 2010-                                                   *)
(*    Francois Bobot                                                      *)
(*    Jean-Christophe Filliatre                                           *)
(*    Johannes Kanig                                                      *)
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software 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.                  *)
(*                                                                        *)
(**************************************************************************)

MARCHE Claude's avatar
MARCHE Claude committed
20
(** Access to Environment, Load Path *)
21

MARCHE Claude's avatar
MARCHE Claude committed
22
open Theory
23 24 25

type env

Andrei Paskevich's avatar
Andrei Paskevich committed
26
val env_tag : env -> Hashweak.tag
27

28
(* module Wenv : Hashweak.S with type key = env *)
29

30
type retrieve_channel = string list -> in_channel
31

32 33 34
type retrieve_theory  = env -> string list -> theory Mnm.t

val create_env : retrieve_channel -> retrieve_theory -> env
35

36 37
exception TheoryNotFound of string list * string

38
val find_theory : env -> string list -> string -> theory
39
  (** [find_theory e p n] finds the theory named [p.n] in environment [e]
Francois Bobot's avatar
Francois Bobot committed
40
      @raise TheoryNotFound if theory not present in env [e] *)
41 42 43

(** Parsers *)

44
type read_channel = env -> string -> in_channel -> theory Mnm.t
45 46 47
  (** a function of type [read_channel] parses the given channel using
      its own syntax. The string argument indicates the origin of the stream
      (e.g. file name) to be used in error messages *)
48

49
val register_format : string -> string list -> read_channel -> unit
50
  (** [register_format name extensions f] registers a new format
51
      under name [name], for files with extensions in list [extensions];
52
      [f] is the function to perform parsing *)
53

54
exception NoFormat
55
exception UnknownExtension of string
56 57 58 59 60
exception UnknownFormat of string (* format name *)

val read_channel : ?format:string -> read_channel
(** [read_channel ?format env f c] returns the map of theories
    in channel [c]. When given, [format] enforces the format, otherwise
61 62
    the format is chosen according to [f]'s extension.
    Beware that nothing ensures that [c] corresponds to the contents of [f]
63

MARCHE Claude's avatar
MARCHE Claude committed
64
    @raise NoFormat if [format] is not given and [f] has no extension
65
    @raise UnknownExtension [s] if the extension [s] is not known in
66
      any registered parser
MARCHE Claude's avatar
MARCHE Claude committed
67
    @raise UnknownFormat [f] if the [format] is not registered
68
*)
69

70
val read_file : ?format:string -> env -> string -> theory Mnm.t
71 72 73
(** [read_file ?format env f] returns the map of theories
    in file [f]. When given, [format] enforces the format, otherwise
    the format is chosen according to [f]'s extension. *)
74

75 76
val list_formats : unit -> (string * string list) list