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 of string Lazy.t list
  29 exception PathNotWellFormed
  30
  31 val interpretate_path :
  32   context:Cic.name list -> DisambiguateTypes.term ->
  33     Cic.term
  34
  35 module type Disambiguator =
  36 sig
  37   (** @param fresh_instances when set to true fresh instances will be generated
  38    * for each number _and_ symbol in the disambiguation domain. Instances of the
  39    * input AST will be ignored. Defaults to false. *)
  40   val disambiguate_term :
  41     ?fresh_instances:bool ->
  42     dbd:HMysql.dbd ->
  43     context:Cic.context ->
  44     metasenv:Cic.metasenv ->
  45     ?initial_ugraph:CicUniv.universe_graph ->
  46     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  47     universe:DisambiguateTypes.multiple_environment option ->
  48     DisambiguateTypes.term ->
  49     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  50      Cic.metasenv *                  (* new metasenv *)
  51      Cic.term *
  52      CicUniv.universe_graph) list *  (* disambiguated term *)
  53     bool  (* has interactive_interpretation_choice been invoked? *)
  54
  55   (** @param fresh_instances as per disambiguate_term *)
  56   val disambiguate_obj :
  57     ?fresh_instances:bool ->
  58     dbd:HMysql.dbd ->
  59     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
  60     universe:DisambiguateTypes.multiple_environment option ->
  61     uri:UriManager.uri option ->     (* required only for inductive types *)
  62     GrafiteAst.obj ->
  63     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  64      Cic.metasenv *                  (* new metasenv *)
  65      Cic.obj *
  66      CicUniv.universe_graph) list *  (* disambiguated obj *)
  67     bool  (* has interactive_interpretation_choice been invoked? *)
  68 end
  69
  70 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
  71
  72 module Trivial:
  73 sig
  74   exception Ambiguous_term of string Lazy.t
  75
  76   (** disambiguate an _unanmbiguous_ term using dummy callbacks which fail if a
  77     * choice from the user is needed to disambiguate the term
  78     * @raise Ambiguous_term for ambiguous term *)
  79   val disambiguate_string:
  80     dbd:HMysql.dbd ->
  81     ?context:Cic.context ->
  82     ?metasenv:Cic.metasenv ->
  83     ?initial_ugraph:CicUniv.universe_graph ->
  84     ?aliases:DisambiguateTypes.environment ->(* previous interpretation status*)
  85     string ->
  86     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
  87      Cic.metasenv *                 (* new metasenv *)
  88      Cic.term *
  89      CicUniv.universe_graph) list   (* disambiguated term *)
  90 end
  91