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 (** {2 Disambiguation interface} *)
  27
  28 exception NoWellTypedInterpretation
  29 exception PathNotWellFormed
  30
  31 val interpretate_path :
  32  context:Cic.name list -> env:DisambiguateTypes.environment -> CicAst.term ->
  33   Cic.term
  34
  35
  36 module type Disambiguator =
  37 sig
  38   val disambiguate_term :
  39     dbd:Mysql.dbd ->
  40     context:Cic.context ->
  41     metasenv:Cic.metasenv ->
  42     ?initial_ugraph:CicUniv.universe_graph ->
  43     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  44     CicAst.term ->
  45     (DisambiguateTypes.environment * (* new interpretation status *)
  46      Cic.metasenv *                  (* new metasenv *)
  47      Cic.term *
  48      CicUniv.universe_graph) list    (* disambiguated term *)
  49
  50   val disambiguate_obj :
  51     dbd:Mysql.dbd ->
  52     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  53     uri:UriManager.uri option ->     (* required only for inductive types *)
  54     TacticAst.obj ->
  55     (DisambiguateTypes.environment * (* new interpretation status *)
  56      Cic.metasenv *                  (* new metasenv *)
  57      Cic.obj *
  58      CicUniv.universe_graph) list    (* disambiguated obj *)
  59 end
  60
  61 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
  62
  63 module Trivial:
  64 sig
  65   exception Ambiguous_term of string
  66
  67   (** disambiguate an _unanmbiguous_ term using dummy callbacks which fail if a
  68     * choice from the user is needed to disambiguate the term
  69     * @raise Ambiguous_term for ambiguous term *)
  70   val disambiguate_string:
  71     dbd:Mysql.dbd ->
  72     ?context:Cic.context ->
  73     ?metasenv:Cic.metasenv ->
  74     ?initial_ugraph:CicUniv.universe_graph ->
  75     ?aliases:DisambiguateTypes.environment ->(* previous interpretation status*)
  76     string ->
  77     (DisambiguateTypes.environment * (* new interpretation status *)
  78      Cic.metasenv *                 (* new metasenv *)
  79      Cic.term *
  80      CicUniv.universe_graph) list   (* disambiguated term *)
  81 end