helm/ocaml/cic_disambiguation/disambiguate.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 open DisambiguateTypes
  27
  28 (** {2 Disambiguation interface} *)
  29
  30 exception NoWellTypedInterpretation
  31
  32 module type Disambiguator =
  33 sig
  34   val disambiguate_term :
  35     dbd:Mysql.dbd ->
  36     context:Cic.context ->
  37     metasenv:Cic.metasenv ->
  38     ?initial_ugraph:CicUniv.universe_graph ->
  39     aliases:environment ->  (* previous interpretation status *)
  40     CicAst.term ->
  41     (environment *                   (* new interpretation status *)
  42      Cic.metasenv *                  (* new metasenv *)
  43      Cic.term*
  44      CicUniv.universe_graph) list    (* disambiguated term *)
  45 end
  46
  47 module Make (C : Callbacks) : Disambiguator
  48
  49 module Trivial:
  50 sig
  51   exception Ambiguous_term of string
  52
  53   (** disambiguate an _unanmbiguous_ term using dummy callbacks which fail if a
  54     * choice from the user is needed to disambiguate the term
  55     * @raise Ambiguous_term for ambiguous term *)
  56   val disambiguate_string:
  57     dbd:Mysql.dbd ->
  58     ?context:Cic.context ->
  59     ?metasenv:Cic.metasenv ->
  60     ?initial_ugraph:CicUniv.universe_graph ->
  61     ?aliases:environment ->         (* previous interpretation status *)
  62     string ->
  63     (environment *                  (* new interpretation status *)
  64      Cic.metasenv *                 (* new metasenv *)
  65      Cic.term *
  66      CicUniv.universe_graph) list   (* disambiguated term *)
  67 end
  68